Commit Graph

383 Commits

Author SHA1 Message Date
Vinay Sajip f38ba78d7d Added documentation for optional delay argument to FileHandler and subclasses. 2008-01-24 12:38:30 +00:00
Gregory P. Smith 7b7ce7854c Fix issue1789: The tutorial contained a misuse of the struct module.
(also remove an unneeded import struct from test_largefile)
2008-01-24 09:38:26 +00:00
Raymond Hettinger c226c31139 Let pprint() support sets and frozensets (suggested by David Mertz). 2008-01-23 00:04:40 +00:00
Raymond Hettinger 2dec48d1c5 Improve variable name in sample code 2008-01-22 22:09:26 +00:00
Raymond Hettinger 9ed5b57fe2 Give zip() the same guarantee as izip() for left-to-right evaluation. 2008-01-22 20:18:53 +00:00
Raymond Hettinger 48c6293500 Document when to use izip_longest(). 2008-01-22 19:51:41 +00:00
Vinay Sajip 733024a752 Minor documentation change - hyperlink tidied up. 2008-01-21 17:39:22 +00:00
Georg Brandl 0751d1ad2a Adapt pydoc to new doc URLs. 2008-01-21 17:13:03 +00:00
Georg Brandl f8dd5b393c Removing bundlebuilder docs again -- it's not to be used anymore (see #779825). 2008-01-21 16:46:58 +00:00
Georg Brandl d7e3e60b87 Add a stub for bundlebuilder documentation. 2008-01-21 16:36:00 +00:00
Georg Brandl 864de8274c #1555501: document plistlib and move it to the general library. 2008-01-21 16:34:07 +00:00
Georg Brandl 960b186eaf Fix example. 2008-01-21 16:28:13 +00:00
Georg Brandl 845c403c08 #1087741: make mmap.mmap the type of mmap objects, not a
factory function. Allow it to be subclassed.
2008-01-21 14:16:46 +00:00
Georg Brandl 5235398323 #1669: don't allow shutil.rmtree() to be called on a symlink. 2008-01-20 14:17:42 +00:00
Georg Brandl 56112895d6 #1648: add sys.gettrace() and sys.getprofile(). 2008-01-20 13:59:46 +00:00
Georg Brandl 92058d2933 #652749: document the constants added to the builtins by site.py. 2008-01-20 13:08:37 +00:00
Georg Brandl 440f2fff14 #799369: document possible sys.platform values. 2008-01-20 12:57:47 +00:00
Georg Brandl 2235011d49 #856047: respect the ``no_proxy`` env var when checking for proxies
in urllib and using the other ``_proxy`` env vars.
Original patch by Donovan Baarda.
2008-01-20 12:05:43 +00:00
Georg Brandl 9b0d46db11 #1178141: add addinfourl.code to get http status code from urllib. 2008-01-20 11:43:03 +00:00
Gregory P. Smith da407232e0 Document that zipfile decryption is insanely slow and fix a typo and
blatant lie in a docstring (it is not useful for security regardless of
how you spell it).
2008-01-20 01:32:00 +00:00
Andrew M. Kuchling 8b506e7a2d Bug 1296: restore text describing OptionGroup 2008-01-19 21:00:38 +00:00
Georg Brandl f558d2e5f5 #1509: fix sqlite3 docstrings and docs w.r.t. cursor.fetchXXX methods. 2008-01-19 20:53:07 +00:00
Georg Brandl e3979f776a #1411695: clarify behavior of xml.sax.utils.[un]escape. 2008-01-19 20:40:24 +00:00
Georg Brandl 309501a617 #1663329: add os.closerange() to close a range of fds,
ignoring errors, and use this in subprocess to speed up
subprocess creation in close_fds mode. Patch by Mike Klaas.
2008-01-19 20:22:13 +00:00
Facundo Batista 873c9857b7 Fix #1693149. Now you can pass several modules separated by
coma to trace.py in the same --ignore-module option.
Thanks Raghuram Devarakonda.
2008-01-19 18:38:19 +00:00
Andrew M. Kuchling 5c60bfcfbf Patch #976880: add mmap .rfind() method, and 'end' paramter to .find().
Contributed by John Lenton.
2008-01-19 18:18:41 +00:00
Georg Brandl 6ebc52749c Clarify thread.join() docs. #1873. 2008-01-19 17:38:53 +00:00
Andrew M. Kuchling e45a77adbe Patch #742598 from Michael Pomraning: add .timeout attribute to SocketServer that will call
.handle_timeout() method when no requests are received within the timeout period.
2008-01-19 16:26:13 +00:00
Andrew M. Kuchling f8f4eb69ce Polish sentence 2008-01-19 13:33:20 +00:00
Georg Brandl a7d70fd438 Amend curses docs by info how to write non-ascii characters.
Thanks to Jeroen Ruigrok van der Werven.
2008-01-19 10:16:09 +00:00
Georg Brandl f8e6afbb66 Fix markup. 2008-01-19 10:11:27 +00:00
Jeffrey Yasskin 45169fbc80 Several tweaks: add construction from strings and .from_decimal(), change
__init__ to __new__ to enforce immutability, and remove "rational." from repr
and the parens from str.
2008-01-19 09:56:06 +00:00
Raymond Hettinger 0fe6ca4673 Better variable name in an example. 2008-01-18 21:14:58 +00:00
Vinay Sajip c7403355df Added section on passing contextual information to logging and documentation for the LoggerAdapter class. 2008-01-18 15:54:14 +00:00
Andrew M. Kuchling 6d22c3961d Typo fix 2008-01-18 02:42:52 +00:00
Raymond Hettinger 64cd1e2d91 Fix markup 2008-01-17 23:56:56 +00:00
Raymond Hettinger 497fdbf767 Fix-up Timer() example. 2008-01-17 23:32:01 +00:00
Raymond Hettinger d0ab014b5e Add advice on choosing between scheduler and threading.Timer(). 2008-01-17 22:27:49 +00:00
Raymond Hettinger 44bd6c0a4f Issue #1861: Add read-only attribute listing upcoming events in the order they will be run. 2008-01-17 19:31:38 +00:00
Gregory P. Smith bde4ae4bde Fixes (accepts patch) issue1339 - http://bugs.python.org/issue1339
- Factor out the duplication of EHLO/HELO in login() and sendmail() to
  a new function, ehlo_or_helo_if_needed().
- Use ehlo_or_helo_if_needed() in starttls()
- Check for the starttls exception in starttls() in the same way as
  login() checks for the auth extension.
Contributed by Bill Fenner.
2008-01-17 08:35:49 +00:00
Raymond Hettinger d59f457279 Note versionadded. 2008-01-17 08:07:05 +00:00
Raymond Hettinger 473170908e Make starmap() match its pure python definition and accept any itertable input (not just tuples). 2008-01-17 03:02:14 +00:00
Raymond Hettinger 171f3916c5 Minor wordsmithing. 2008-01-16 23:38:16 +00:00
Georg Brandl 5c8b2abf71 Fix MSDN library URL. (#1854) 2008-01-16 16:56:29 +00:00
Andrew M. Kuchling 95f17bbfc0 Markup fix 2008-01-16 13:01:51 +00:00
Raymond Hettinger e805782b53 Fix-up half-written paragraph in the docs 2008-01-15 21:22:47 +00:00
Raymond Hettinger f59e962b49 Refactor if/elif chain for clarity and speed. Remove dependency on subclasses having to implement _empty and _full. 2008-01-15 20:52:42 +00:00
Jeffrey Yasskin d7b00334f3 Add rational.Rational as an implementation of numbers.Rational with infinite
precision. This has been discussed at http://bugs.python.org/issue1682. It's
useful primarily for teaching, but it also demonstrates how to implement a
member of the numeric tower, including fallbacks for mixed-mode arithmetic.

I expect to write a couple more patches in this area:
 * Rational.from_decimal()
 * Rational.trim/approximate() (maybe with different names)
 * Maybe remove the parentheses from Rational.__str__()
 * Maybe rename one of the Rational classes
 * Maybe make Rational('3/2') work.
2008-01-15 07:46:24 +00:00
Raymond Hettinger 907cda6ebb Small grammar nit 2008-01-15 05:46:43 +00:00
Skip Montanaro f233b0c454 Better (?) text describing the lack of guarantees provided by qsize(),
empty() and full().
2008-01-15 03:40:20 +00:00
Andrew M. Kuchling f15ff46be5 Markup fix 2008-01-15 01:29:44 +00:00
Andrew M. Kuchling 7ce9b18460 Typo fixes 2008-01-15 01:29:16 +00:00
Christian Heimes c94e2b5c12 Now that I've learnt about structseq objects I felt like converting sys.float_info to a structseq. It's
readonly and help(sys.float_info) explains the attributes nicely.
2008-01-14 04:13:37 +00:00
Christian Heimes f31b69f9db Applied patch #1816: sys.flags patch 2008-01-14 03:42:48 +00:00
Georg Brandl 9f1e2ecb48 Clarify the effect of text mode. 2008-01-13 09:36:18 +00:00
Georg Brandl fca4e1ffa1 Fix editing glitch. 2008-01-12 16:11:09 +00:00
Georg Brandl 57fe0f2902 Move OSError docs to exceptions doc, remove obsolete descriptions
from os docs, rework posix docs.
2008-01-12 10:53:29 +00:00
Mark Dickinson 59bc20bb27 Issue 1780: Allow leading and trailing whitespace in Decimal constructor,
when constructing from a string. Disallow trailing newlines in
Context.create_decimal.
2008-01-12 01:56:00 +00:00
Raymond Hettinger bed4dd459d Update the opcode docs for STORE_MAP and BUILD_MAP 2008-01-11 23:25:18 +00:00
Andrew M. Kuchling de68037202 Bug #1790: update link; remove outdated paragraph 2008-01-11 19:33:24 +00:00
Georg Brandl e3c3db59b5 Documentation for r5990[3567]. 2008-01-11 09:55:53 +00:00
Raymond Hettinger d1ef85420f Run doctests on the collections module 2008-01-11 00:23:13 +00:00
Raymond Hettinger 15b5e55b48 Neaten-up the named tuple docs 2008-01-10 23:00:01 +00:00
Amaury Forgeot d'Arc d08a8ebf2a Closing issue1761.
Surprising behaviour of the "$" regexp: it matches the
end of the string, AND just before the newline at the end
of the string::

    re.sub('$', '#', 'foo\n') == 'foo#\n#'

Python is consistent with Perl and the pcre library, so
we just document it.
Guido prefers "\Z" to match only the end of the string.
2008-01-10 21:59:42 +00:00
Raymond Hettinger e850c466c7 Clarify how to add a field to a named tuple. 2008-01-10 20:37:12 +00:00
Raymond Hettinger e1655088ca Examples for named tuple subclassing should include __slots__ 2008-01-10 19:15:10 +00:00
Raymond Hettinger dc1854dec4 Fix typo 2008-01-09 03:13:20 +00:00
Raymond Hettinger e11230e11b Syntax highlighting only works when >>> lines are accompanied by ... lines 2008-01-09 03:02:23 +00:00
Georg Brandl 502d6312db Fix markup errors from r59857 and clarify key.__enter__/__exit__ docs 2008-01-08 16:18:26 +00:00
Christian Heimes b39a756afd Added __enter__ and __exit__ functions to HKEY object
Added ExpandEnvironmentStrings to the _winreg module.
2008-01-08 15:46:10 +00:00
Andrew M. Kuchling e0a49b6e05 Patch 1137: allow assigning to .buffer_size attribute of PyExpat.parser objects 2008-01-08 14:30:55 +00:00
Raymond Hettinger ac5742e0fe Docs on named tuple's naming conventions and limits of subclassing 2008-01-08 02:24:15 +00:00
Raymond Hettinger f6b769b464 Documentation nits. 2008-01-07 21:33:51 +00:00
Raymond Hettinger f5e8af1bb7 Use get() instead of pop() for the optimized version of _replace(). 2008-01-07 20:56:05 +00:00
Raymond Hettinger fb3ced663d Minor markup fix 2008-01-07 20:17:35 +00:00
Raymond Hettinger 9a359210aa Cleanup named tuple subclassing example. 2008-01-07 20:07:38 +00:00
Vinay Sajip aa0665ba17 Added section about adding contextual information to log output. 2008-01-07 19:40:10 +00:00
Georg Brandl 61d2886491 Fix two further doc build warnings. 2008-01-07 18:57:03 +00:00
Georg Brandl 62416bcf5a #467924, patch by Alan McIntyre: Add ZipFile.extract and ZipFile.extractall. 2008-01-07 18:47:44 +00:00
Georg Brandl 62647653eb Restructure urllib doc structure. 2008-01-07 18:23:27 +00:00
Georg Brandl 2da0fceba7 Patch #602345 by Neal Norwitz and me: add -B option and PYTHONDONTWRITEBYTECODE envvar to skip writing bytecode. 2008-01-07 17:09:35 +00:00
Georg Brandl b3255ed8c9 Restore "somenamedtuple" as the "class" for named tuple attrs. 2008-01-07 16:43:47 +00:00
Mark Summerfield 86dfee5c45 Added a hyperlink from sequence types to mutable sequence types. 2008-01-07 16:42:08 +00:00
Christian Heimes fb2d25a154 Issue #1646: Make socket support TIPC. The socket module now has support
for TIPC under Linux, see http://tipc.sf.net/ for more information.
Thanks to Alberto Bertogli for the patch
2008-01-07 16:12:44 +00:00
Vinay Sajip e28fa297e9 Updated docs for basicConfig to indicate it's a no-op if handlers have been defined for the root logger. 2008-01-07 15:30:36 +00:00
Georg Brandl 503f2935c9 Clean up markup. 2008-01-07 09:18:17 +00:00
Georg Brandl 3c403b2370 Consistency nit. 2008-01-07 09:16:08 +00:00
Georg Brandl 66502c11e9 Change virtual class name of __iter__ to "object" in order to make it linkable. 2008-01-07 09:07:38 +00:00
Raymond Hettinger dc55f35f38 Add another named tuple subclassing example. 2008-01-07 09:03:49 +00:00
Raymond Hettinger 1db6f80cd5 Cleanup subclassing example to more clearly show fixed-width print format. 2008-01-07 05:50:35 +00:00
Raymond Hettinger b8e0072fec Add subclassing example to docs for named tuples. 2008-01-07 04:24:49 +00:00
Georg Brandl 4273222a68 Remove latex trace. 2008-01-06 23:22:27 +00:00
Georg Brandl 27a2d1332b Fix introductory sentence. 2008-01-06 17:21:00 +00:00
Georg Brandl e260ba2d33 #1325: Add docs and tests for zipimporter.archive and zipimporter.prefix. 2008-01-06 16:49:50 +00:00
Georg Brandl 516787dd98 #1499: Document compile() exceptions. 2008-01-06 16:22:56 +00:00
Georg Brandl 81de0d24d5 #1582: document __reversed__, patch by Mark Russell. 2008-01-06 16:17:56 +00:00
Georg Brandl ec32b6bce7 #1559684: document that shutil.copy* doesn't copy all metadata on Posix and Windows too. 2008-01-06 16:12:39 +00:00
Georg Brandl 14aaee143d #1686390: add example for csv.Sniffer use. 2008-01-06 16:04:56 +00:00
Georg Brandl 2cb103ffa9 #1727024: document that Popen.returncode is set by Popen.poll/wait. 2008-01-06 16:01:26 +00:00
Georg Brandl c4768a4a98 #1615275: clarify return object types of different tempfile factories. 2008-01-06 15:55:26 +00:00
Georg Brandl 91a4808aa8 #759525: document that dir() doesn't return metaclass attrs when given a class as arg. 2008-01-06 15:48:20 +00:00
Georg Brandl db210dfba2 #1501: document that 0**0 == 1. 2008-01-06 15:41:50 +00:00
Georg Brandl a8cbad3b83 #1755097: document default values for [].sort() and sorted(). 2008-01-06 15:34:57 +00:00
Georg Brandl 437e15d42b #1680: fix context manager example function name. 2008-01-06 15:30:34 +00:00
Raymond Hettinger 1166872006 Small code simplification. Forgot that classmethods can be called from intances. 2008-01-06 09:02:24 +00:00
Georg Brandl 165010834a #1719: capitalization error in "UuidCreate". 2008-01-05 20:46:29 +00:00
Georg Brandl 2fa2f5d3e5 Revert socket.rst to unix-eol. 2008-01-05 20:29:13 +00:00
Georg Brandl f725b9587c Doc patch #1730 from Robin Stocker; minor corrections mostly to os.rst. 2008-01-05 19:44:22 +00:00
Georg Brandl 9749e15e2f Remove with_statement future imports from 2.6 docs. 2008-01-05 19:28:16 +00:00
Jeffrey Yasskin 9871d8fe22 Continue rolling back pep-3141 changes that changed behavior from 2.5. This
round included:
 * Revert round to its 2.6 behavior (half away from 0).
 * Because round, floor, and ceil always return float again, it's no
   longer necessary to have them delegate to __xxx___, so I've ripped
   that out of their implementations and the Real ABC. This also helps
   in implementing types that work in both 2.6 and 3.0: you return int
   from the __xxx__ methods, and let it get enabled by the version
   upgrade.
 * Make pow(-1, .5) raise a ValueError again.
2008-01-05 08:47:13 +00:00
Raymond Hettinger 1b50fd7cb3 Add error-checking to namedtuple's _replace() method. 2008-01-05 02:17:24 +00:00
Raymond Hettinger 02740f73ff Improve namedtuple's _cast() method with a docstring, new name, and error-checking. 2008-01-05 01:35:43 +00:00
Andrew M. Kuchling 54966a5f94 Fix markup 2008-01-04 18:25:05 +00:00
Christian Heimes 04ae916fa2 Added interface to Windows' WSAIoctl and a simple example for a network sniffer. 2008-01-04 15:23:30 +00:00
Raymond Hettinger e0734e7dc0 Minor fix-ups to named tuples:
* Make the _replace() method respect subclassing.

* Using property() to make _fields read-only wasn't a good idea.
  It caused len(Point._fields) to fail.

* Add note to _cast() about length checking and alternative with the star-operator.
2008-01-04 03:22:53 +00:00
Andrew M. Kuchling 7ef1ce69d0 Markup fixes; grammar tweaks 2008-01-04 01:15:50 +00:00
Christian Heimes eebb79cc69 Added copysign(x, y) function to the math module 2008-01-03 22:32:26 +00:00
Christian Heimes e2ca4245c9 Added math.isinf() and math.isnan() 2008-01-03 20:23:15 +00:00
Jeffrey Yasskin 2f3c16be73 Backport PEP 3141 from the py3k branch to the trunk. This includes r50877 (just
the complex_pow part), r56649, r56652, r56715, r57296, r57302, r57359, r57361,
r57372, r57738, r57739, r58017, r58039, r58040, and r59390, and new
documentation. The only significant difference is that round(x) returns a float
to preserve backward-compatibility. See http://bugs.python.org/issue1689.
2008-01-03 02:21:52 +00:00
Raymond Hettinger 81a885af05 Improve docs for itertools.groupby(). The use of xrange(0) to create a unique object is less obvious than object(). 2007-12-29 22:16:24 +00:00
Raymond Hettinger 5d332bbdee Simpler documentation for itertools.tee(). Should be backported. 2007-12-29 22:09:34 +00:00
Georg Brandl b19be571e0 Some cleanup in the docs. 2007-12-29 10:57:00 +00:00
Guido van Rossum 02de8979cc Patch #1583 by Adam Olsen.
This adds signal.set_wakeup_fd(fd) which sets a file descriptor to
which a zero byte will be written whenever a C exception handler runs.

I added a simple C API as well, PySignal_SetWakeupFd(fd).
2007-12-19 19:41:06 +00:00
Raymond Hettinger 85dfcf3530 Users demand iterable input for named tuples. The author capitulates. 2007-12-18 23:51:15 +00:00
Christian Heimes 0a8143f646 Applied patch #1635: Float patch for inf and nan on Windows (and other platforms).
The patch unifies float("inf") and repr(float("inf")) on all platforms.
2007-12-18 23:22:54 +00:00
Raymond Hettinger 8777bcae27 Simplify and speedup _asdict() for named tuples. 2007-12-18 22:21:27 +00:00
Raymond Hettinger 88880b2dd6 Add more namedtuple() test cases. Neaten the code and comments. 2007-12-18 00:13:45 +00:00
Georg Brandl 1bd51e3eec Remove curious space-like characters. 2007-12-16 16:00:36 +00:00
Georg Brandl 6dfe956bfc Remove another unnecessary Unicode character. 2007-12-16 15:59:19 +00:00
Georg Brandl 459744cc71 Remove gratuitous unicode character. 2007-12-16 15:53:49 +00:00
Georg Brandl 05df69b2ea Remove orphaned footnote reference. 2007-12-16 15:47:46 +00:00
Raymond Hettinger e846f38c77 Add usage note 2007-12-14 21:51:50 +00:00
Raymond Hettinger 07ae83f840 Faster and simpler _replace() method 2007-12-14 19:19:59 +00:00
Raymond Hettinger 48eca67ab9 Add line spacing for readability 2007-12-14 18:08:20 +00:00
Raymond Hettinger 42da874cdd Cleaner method naming convention 2007-12-14 02:49:47 +00:00
Raymond Hettinger 04a9a0e904 Simplify implementation of __replace__() 2007-12-13 22:55:52 +00:00
Christian Heimes 7c7f6afa92 Added wide char api variants of getch and putch to msvcrt module. The wide char methods are required to fix #1578 in py3k. I figured out that they might be useful in 2.6, too. 2007-12-10 15:12:41 +00:00
Brett Cannon 338d41850a Use a versionchanged directive. 2007-12-09 05:09:37 +00:00
Skip Montanaro 546624609e correct email address 2007-12-08 15:26:16 +00:00
Georg Brandl e40a6a85ee Add examples to the datetime documentation. Written for GHOP by "h4wk.cz". 2007-12-08 11:23:13 +00:00
Raymond Hettinger ba9eea5aaa Don't have the docs berate themselves. Keep a professional tone.
If a todo is needed, put it in the tracker.
2007-12-07 01:53:01 +00:00
Georg Brandl d6b20dc54f Better re.split examples. 2007-12-06 09:45:39 +00:00
Georg Brandl 2b92f6bab3 Diverse markup fixes. 2007-12-06 01:52:24 +00:00
Georg Brandl b8df156ab5 Add examples to re docs. Written for GHOP by Dan Finnie. 2007-12-05 18:30:48 +00:00
Georg Brandl 722e1011c9 Add examples to csv, pprint and traceback docs.
Written by Ross for GHOP.
2007-12-05 17:56:50 +00:00
Georg Brandl c37f288ec6 Add tutorial and examples to logging docs, from GHOP student "oscar8thegrouch". 2007-12-04 17:46:27 +00:00
Georg Brandl 0a0cf16de9 Add examples to the xmlrpclib docs.
Written for GHOP by Josip Dzolonga.
2007-12-03 20:03:46 +00:00
Christian Heimes 44eeaec173 Patch #1537 from Chad Austin
Change GeneratorExit's base class from Exception to BaseException
(This time I'm applying the patch to the correct sandbox.)
2007-12-03 20:01:02 +00:00
Martin v. Löwis 6b449f4f2b Issue #1727780: Support loading pickles of random.Random objects created
on 32-bit systems on 64-bit systems, and vice versa. As a consequence
of the change, Random pickles created by Python 2.6 cannot be loaded
in Python 2.5.
2007-12-03 19:20:02 +00:00
Georg Brandl 584265b001 Add more entries to the glossary.
Written by Jeff Wheeler for GHOP.
2007-12-02 14:58:50 +00:00