Commit Graph

13089 Commits

Author SHA1 Message Date
R David Murray 5e0c57142d #10423: clarify options vs args in argparse discussion of optparse
Patch by Sandro Tosi.
2012-03-30 18:07:42 -04:00
Eli Bendersky c1d9869cb9 Issue #14006: improve the documentation of xml.etree.ElementTree
Removed the useless explanation of the Element data structure that started the
documentation page. Instead, the documentation now starts with a brief tutorial
skimming some of the capabilities of the module. The tutorial can be followed
by additional topic-specific sections (such as XPath support), and eventually
by a reference that goes over the module's classes and functions, as usual.
2012-03-30 11:44:15 +03:00
Eli Bendersky dbaedb8cf9 fix typo in glossary 2012-03-30 11:02:05 +03:00
Eli Bendersky 6bdb650ab2 Added the "provisional package" glossary term from PEP 411 2012-03-30 10:52:25 +03:00
Michael Foord e55f6636cc Fix typo in unittest.mock docs 2012-03-29 13:46:50 +01:00
R David Murray eac0939ddd #14416: conditionally add LOG_AUTHPRIV facility and LOG_ODELAY to syslog.
Unlike the other facilities, we don't use a fallback for AUTHPRIV if it
doesn't exist.  Because it is intended for logging sensitive log messages, it
is better that a program trying to log such messages fail than that it log
them insecurely.

Initial patch by Federico Reghenzani.
2012-03-29 07:15:45 -04:00
R David Murray 8c696321eb Merge #14416: add missing LOG_SYSLOG facility to syslog docs. 2012-03-29 06:49:29 -04:00
R David Murray 07cf1d8085 #14416: add missing LOG_SYSLOG facility to syslog docs. 2012-03-29 06:47:35 -04:00
Georg Brandl 909f5bc849 Fix newlines. 2012-03-29 09:18:14 +02:00
Michael Foord 324b58bf18 Update unittest.mock.patch example 2012-03-28 15:49:08 +01:00
Michael Foord 2309ed861a Re-order unittest.mock documentation to put magic method support before the helpers 2012-03-28 15:38:36 +01:00
Michael Foord 901553668a Adding an example to unittest.mock.patch documentation 2012-03-28 15:32:08 +01:00
Michael Foord 54b3db8c84 Minor unittest.mock.patch doc / docstring improvement 2012-03-28 15:08:08 +01:00
Michael Foord a9e6fb201d Unsplit unittest.mock documentation 2012-03-28 14:36:02 +01:00
Eli Bendersky ede001a832 Fix doc typo noticed by Amaury Forgeot d'Arc 2012-03-27 04:57:23 +02:00
Eli Bendersky 3a4875e5e3 Issue #6488: Explain the XPath support of xml.etree.ElementTree, with code
samples and a reference. Also fix the other nits mentioned in the issue.

This also partially addresses issue #14006.
2012-03-26 20:43:32 +02:00
Sandro Tosi 70ea34de85 Issue #14410: merge with 3.2 2012-03-26 19:36:44 +02:00
Sandro Tosi 99e7d0706e Issue #14410: fix typo in argparse doc; patch by Tshepang Lekhonkhobe 2012-03-26 19:36:23 +02:00
R David Murray 4a1ad9148b #14413: tweak word order in deprecation section 2012-03-26 13:34:46 -04:00
Vinay Sajip 38a12af36a Updated handler documentation. 2012-03-26 17:17:39 +01:00
Vinay Sajip 8ece80faae Minor documentation tweak. 2012-03-26 17:09:58 +01:00
Michael Foord 944e02d055 Adding unittest.mock documentation 2012-03-25 23:12:55 +01:00
Georg Brandl 87b3caf873 merge with 3.2 2012-03-25 20:41:06 +02:00
Georg Brandl d34fc8b275 Add missing files for new doc theme. 2012-03-25 20:40:57 +02:00
Georg Brandl 288b9bf1ea merge with 3.2 2012-03-25 20:32:35 +02:00
Georg Brandl ab7121430e Switch to new "lighter" doc design. 2012-03-25 20:31:57 +02:00
Andrew Svetlov 1d5617958f Remove extra spaces in doc example. 2012-03-25 11:44:59 +03:00
Georg Brandl 1a7742eb4d merge with 3.2 2012-03-25 08:43:32 +02:00
Georg Brandl 11ee31ab08 Closes #14401: fix typos in curses howto. 2012-03-25 08:43:22 +02:00
Eli Bendersky 60ee04969e Issue #14349: Fix the doc of the MAKE_FUNCTION opcode in Doc/library/dis.rst to
correctly list the stack params it expects.
2012-03-24 18:52:45 +02:00
Martin v. Löwis ecc92db031 merge 3.2 2012-03-24 17:40:50 +01:00
Martin v. Löwis 2dee394af9 Issue #14400: Fix typo. 2012-03-24 17:39:57 +01:00
Georg Brandl 226ed7ecbd Fix indentation. 2012-03-24 08:12:41 +01:00
Stefan Krah b6405efd1b Use the same exception hierarchy as decimal.py. FloatOperation now also
inherits from TypeError. Cleanup in module initialization to make repeated
import failures robust.
2012-03-23 14:46:48 +01:00
Eli Bendersky 396e8fcf36 Issue #13782: streamline argument type-checking in ET.Element
append, extend and insert now consistently type-check their argument in both
the C and Python implementations, and raise TypeError for non-Element
argument.

Added tests
2012-03-23 14:24:20 +02:00
R David Murray 8680bcc5db #14380: Have MIMEText defaults to utf-8 when passed non-ASCII unicode
Previously it would just accept the unicode, which would wind up as unicode in
the transfer-encoded message object, which is just wrong.

Patch by Jeff Knupp.
2012-03-22 22:17:51 -04:00
Georg Brandl 2ac82f8dc9 Fix indentation. 2012-03-22 22:20:21 +01:00
Antoine Pitrou d5d17eb653 Issue #14204: The ssl module now has support for the Next Protocol Negotiation extension, if available in the underlying OpenSSL library.
Patch by Colin Marc.
2012-03-22 00:23:03 +01:00
Stefan Krah 851a07e5c2 Document decimal.MIN_ETINY. 2012-03-21 18:47:20 +01:00
Stefan Krah 1919b7e72b Issue #7652: Integrate the decimal floating point libmpdec library to speed
up the decimal module. Performance gains of the new C implementation are
between 12x and 80x, depending on the application.
2012-03-21 18:25:23 +01:00
Larry Hastings 83a9f48699 Issue #14328: Add keyword-only parameters to PyArg_ParseTupleAndKeywords.
They're optional-only for now (unlike in pure Python) but that's all
I needed.  The syntax can easily be relaxed if we want to support
required keyword-only arguments for extension types in the future.
2012-03-20 20:06:16 +00:00
Victor Stinner 2bf1f3bee4 time.steady() doc: don't repeat the default value 2012-03-19 13:17:24 +01:00
R David Murray da3d8e05b6 Merge #14355: remove obsolete doc reference to previously removed init_frozen.
Patch by Eric Snow.
2012-03-18 20:50:36 -04:00
R David Murray 1623afff67 #14355: remove obsolete doc reference to previously removed init_frozen.
Patch by Eric Snow.
2012-03-18 20:50:03 -04:00
Georg Brandl 869ac7895f merge with 3.2 2012-03-17 17:29:39 +01:00
Georg Brandl 3a19e542ff Closes #14250: regex.flags has not only explicit flags but also implicit flags and those from the pattern 2012-03-17 17:29:27 +01:00
Georg Brandl 9758fcfb87 merge with 3.2 2012-03-17 17:26:36 +01:00
Georg Brandl 557a3ec9bb Closes #14343: avoid shadowing builtin input() in example code. 2012-03-17 17:26:27 +01:00
Georg Brandl 5ec6fdb0f6 Closes #14342: remove out-of-date section about avoiding recursion errors. 2012-03-17 17:25:47 +01:00
Georg Brandl 2ba1428911 merge with 3.2 2012-03-17 16:58:12 +01:00
Georg Brandl 12c3cd7c1f Closes #14306: clarify expensiveness of try-except and update code snippet 2012-03-17 16:58:05 +01:00
Eli Bendersky 7add4eaa6d updated whatsnew/3.3.rst with the new methods added to list and bytearray (issue 10516) 2012-03-17 15:14:35 +02:00
Senthil Kumaran 8df2634a7e merge from 3.2 - issue6566 2012-03-17 00:41:15 -07:00
Senthil Kumaran f2123d2db5 3.2 explain json.dumps for non-string keys in dicts. closes issue6566. Patch contributed Kirubakaran Athmanathan 2012-03-17 00:40:34 -07:00
R David Murray 9b3d4847e5 Merge #11780: s/throw/raise/ 2012-03-16 22:10:44 -04:00
R David Murray 41914349ad #11780: s/throw/raise/ 2012-03-16 22:10:00 -04:00
R David Murray 1ad2eeaa99 Merge #11780: document that email.encoders throw TypeError on multipart messages. 2012-03-16 22:04:25 -04:00
R David Murray 69ebfe43b0 #11780: document that email.encoders throw TypeError on multipart messages. 2012-03-16 22:03:17 -04:00
Eli Bendersky c105cf5aff Issue #14202: some additional doc fixes 2012-03-16 16:51:01 +02:00
Eli Bendersky 969b8daf5a Issue #14202: some additional doc fixes 2012-03-16 16:49:58 +02:00
Eli Bendersky 68ca5a6bcc Issue #14202: Greatly enhance the documentation of xml.dom.pulldom.
Patch by Florian Mladitsch
2012-03-16 14:40:13 +02:00
Eli Bendersky 3fb05a90ce Issue #14202: Greatly enhance the documentation of xml.dom.pulldom.
Patch by Florian Mladitsch
2012-03-16 14:37:14 +02:00
Eli Bendersky 2a1e74a075 Issue #13709: some fixes to the ctypes documentation. In addition to fixing
the problems pointed in the issue, I removed the confusing Windows/Linux
distinction. It serves no real goal in the documentation, and is probably
wrong anyway since for Windows the WINFUNCTYPE constructor should be used.
In addition, the "look, this is faster on Linux" comment is misleading since
it's not explained. The outcome may just be an artifact of qsort implementation
for this particular input, and may change between C runtime version releases.
2012-03-16 09:17:43 +02:00
Eli Bendersky 3405001491 Issue #9257: clarify the events iterparse accepts 2012-03-16 08:42:36 +02:00
Eli Bendersky 604c4ff43d Issue #9257: clarify the events iterparse accepts 2012-03-16 08:41:30 +02:00
Eli Bendersky 5b77d81314 Issue #14207: the ParseError exception raised by _elementtree was made
consistent to the one raised by the Python module (the 'code' attribute
was added).

In addition, the exception is now documented.

Added a test to check that ParseError has the required attributes, and
threw away the equivalent doctest which is no longer required.
2012-03-16 08:20:05 +02:00
Senthil Kumaran e53d977e80 Explain the use of charset parameter with Content-Type header: issue11082 2012-03-15 18:15:34 -07:00
Senthil Kumaran 6b3434ae04 Explain the use of charset parameter with Content-Type header. Issue11082 2012-03-15 18:11:16 -07:00
Giampaolo Rodola' a4e018889a (sched) when run() is invoked with blocking=False return the deadline of the next scheduled call in the scheduler; this use case was suggested in http://bugs.python.org/issue1641#msg149453 2012-03-15 13:05:41 +01:00
R David Murray 7cc7033cb4 Merge #12758: removing confusing mention of UTC from time.time description
Patch by Dylan Sarber.

(Not sure why hg told me it merged pyexpat.c too, it showed no changes)
2012-03-15 03:09:53 -04:00
R David Murray 38c2754652 #12758: removing confusing mention of UTC from time.time description
Patch by Dylan Sarber.
2012-03-15 03:06:15 -04:00
Andrew Svetlov d3d7c903e6 Closes issue #14163 - tkinter: problems with hello doc example 2012-03-14 21:41:23 -07:00
Raymond Hettinger 4775def25d merge 2012-03-14 18:17:20 -07:00
Raymond Hettinger 13ec112b3a Issue #13248: Removed docs for two deprecated unittest features. To be conservative, the code is left in for one more release. 2012-03-14 18:16:18 -07:00
Senthil Kumaran 7596aeaba7 cpython:Fix the wrong urllib exampls which use str for POST data. Closes Issue11261 2012-03-14 18:11:46 -07:00
Senthil Kumaran 87684e6eea Fix the wrong urllib exampls which use str for POST data. Closes Issue11261 2012-03-14 18:08:13 -07:00
Victor Stinner 071eca3f5c Issue #10278: Add an optional strict argument to time.steady(), False by default 2012-03-15 01:17:09 +01:00
Victor Stinner ec919cc74d Issue #10278: Drop time.monotonic() function, rename time.wallclock() to time.steady()
* On Mac OS X, time.steady() now uses mach_absolute_time(), a monotonic clock
 * Optimistic change: bet that CLOCK_MONOTONIC and CLOCK_REALTIME are available
   when clock_gettime() is available
 * Rewrite time.steady() documentation
2012-03-15 00:58:32 +01:00
Georg Brandl 30162be9e4 merge with 3.2 2012-03-14 22:42:49 +01:00
Georg Brandl 300a691026 Closes #14305: fix typo. 2012-03-14 22:40:08 +01:00
Senthil Kumaran 38b968b913 deprecated the old urllib primitives in 3.3 urllib package - issue 10050 2012-03-14 13:43:53 -07:00
Georg Brandl 846acf5c0c #14289: merge with 3.2 2012-03-14 08:18:59 +01:00
Georg Brandl 525fd5447d Closes #14289: put a link to the CHM download page on the docs download page. 2012-03-14 08:18:47 +01:00
Georg Brandl 5cd2767144 #14283: merge with 3.2 2012-03-14 08:07:29 +01:00
Georg Brandl 69c7a69cbe Closes #14283: match() and search() are regex methods, not match methods. 2012-03-14 08:02:43 +01:00
Georg Brandl b20a019d46 Closes #14298: update section about dict implementation. 2012-03-14 07:50:17 +01:00
Senthil Kumaran 1725feabd0 default: closes Issue12365 - Add an example explaining the context manager use case of urllib.urlopen 2012-03-13 19:48:37 -07:00
Senthil Kumaran 21c71bac5f closes Issue12365 - Add an example explaining the context manager use case of urllib.urlopen 2012-03-13 19:47:51 -07:00
Senthil Kumaran e24f96a059 Issue10050 - urlretrieve uses newer urlopen. reporthook of urlretrieve takes, block number, block read size, file_size 2012-03-13 19:29:33 -07:00
Victor Stinner 30c825c751 What's New in Python 3.3: Repeat the dict lookup change in Porting section 2012-03-14 00:40:57 +01:00
Victor Stinner ecc6e6613f Fix doc of datetime.date*.*fromtimestamp() methods 2012-03-14 00:39:29 +01:00
Victor Stinner 21f5893571 Issue #14180: datetime.date.fromtimestamp(), datetime.datetime.fromtimestamp()
and datetime.datetime.utcfromtimestamp() now raise an OSError instead of
ValueError if localtime() or gmtime() failed.
2012-03-14 00:15:40 +01:00
Victor Stinner 5d272cc6a2 Close #14180: Factorize code to convert a number of seconds to time_t, timeval or timespec
time.ctime(), gmtime(), time.localtime(), datetime.date.fromtimestamp(),
datetime.datetime.fromtimestamp() and datetime.datetime.utcfromtimestamp() now
raises an OverflowError, instead of a ValueError, if the timestamp does not fit
in time_t.

datetime.datetime.fromtimestamp() and datetime.datetime.utcfromtimestamp() now
round microseconds towards zero instead of rounding to nearest with ties going
away from zero.
2012-03-13 13:35:55 +01:00
Senthil Kumaran 9186850088 closes issue14257 - Grammatical fix 2012-03-12 10:05:58 -07:00
Senthil Kumaran 6080db7606 closes issue14257 - Grammatical fix 2012-03-12 10:05:34 -07:00
Senthil Kumaran 68e994e9e4 closes issue14257 - cpython - minor error in glossary wording regarding __hash__ 2012-03-11 21:06:03 -07:00
Senthil Kumaran a7fccd8b14 closes issue14257 - 3.2 minor error in glossary wording regarding __hash__ 2012-03-11 21:04:56 -07:00
Georg Brandl 4c7c3c58be Close #14210: add command argument completion to pdb: complete file names, global/local variables, aliases 2012-03-10 22:36:48 +01:00
Georg Brandl a08e7e1c5d Close #14248: fix typo. 2012-03-10 20:52:16 +01:00
Mark Dickinson c7ceb2bc95 merge 3.2 (#9574) 2012-03-10 16:11:49 +00:00
Mark Dickinson 328dd0d5f3 Closes #9574: Note that complex constructor doesn't allow whitespace around central operator. 2012-03-10 16:09:35 +00:00
Georg Brandl 6aacc14e29 Merge with 3.2. 2012-03-10 09:27:30 +01:00
Georg Brandl 64a40949cf Closes #14186: add link to PEP 3107 (function annotations) to the function definition section. 2012-03-10 09:22:47 +01:00
Victor Stinner 8c43e69bce Issue #14205: Document the dict lookup change in What's New in Python 3.3 2012-03-09 14:04:01 +01:00
Georg Brandl f5a1d76b48 Fix indentation. 2012-03-09 12:22:12 +01:00
Senthil Kumaran 065dedaf47 Fix closes Issue: 14217 - 3.2 branch 2012-03-08 20:56:52 -08:00
Senthil Kumaran 74d5657c80 Fix closes Issue: 14217 - Appropriate sphinx directive for output. Patch by Tshepang Lekhonkhobe 2012-03-08 20:54:34 -08:00
Georg Brandl 4dcf474337 Fix indentation. 2012-03-08 20:35:08 +01:00
Victor Stinner 50dbb3f2cf Issue #14205: document the change of dict[key] behaviour if dict is modified
during the lookup
2012-03-08 02:50:17 +01:00
Jason R. Coombs 30b8e5461d Use PEP-8 style in logging example 2012-03-07 10:26:08 -05:00
Jason R. Coombs 8a56085b51 Merge: Use PEP-8 style in logging example 2012-03-07 10:27:07 -05:00
Georg Brandl d6c4340f77 Add todo item about hash randomization. 2012-03-07 08:55:52 +01:00
Brett Cannon f67e494ca8 merge 2012-03-06 15:33:24 -05:00
Stefan Krah abd887d690 Issue #14181: Improve clarity in the documentation for the multi-purpose
Py_buffer.obj field.
2012-03-06 14:55:06 +01:00
Nick Coghlan b9b281b787 Add some simple examples to the PEP 380 section of What's New 2012-03-06 22:31:12 +10:00
Nick Coghlan 98e20701cb Add PEP 414 to What's New, consolidate memoryview entries 2012-03-06 21:50:13 +10:00
Martin v. Löwis de157cc5bc Issue #14200: Add benchmark results to text flow. 2012-03-06 08:42:17 +01:00
Antoine Pitrou bdb1cf1ca5 Issue #12328: Fix multiprocessing's use of overlapped I/O on Windows.
Also, add a multiprocessing.connection.wait(rlist, timeout=None) function
for polling multiple objects at once.  Patch by sbt.

Complete changelist from sbt's patch:

* Adds a wait(rlist, timeout=None) function for polling multiple
  objects at once.  On Unix this is just a wrapper for
  select(rlist, [], [], timeout=None).

* Removes use of the SentinelReady exception and the sentinels argument
  to certain methods.  concurrent.futures.process has been changed to
  use wait() instead of SentinelReady.

* Fixes bugs concerning PipeConnection.poll() and messages of zero
  length.

* Fixes PipeListener.accept() to call ConnectNamedPipe() with
  overlapped=True.

* Fixes Queue.empty() and SimpleQueue.empty() so that they are
  threadsafe on Windows.

* Now PipeConnection.poll() and wait() will not modify the pipe except
  possibly by consuming a zero length message.  (Previously poll()
  could consume a partial message.)

* All of multiprocesing's pipe related blocking functions/methods are
  now interruptible by SIGINT on Windows.
2012-03-05 19:28:37 +01:00
Éric Araujo 6a59b70cba Merge 3.2 2012-03-05 16:24:07 +01:00
Éric Araujo 80f7102d43 Improve packaging.database documentation 2012-03-05 16:16:37 +01:00
Éric Araujo e5eec7e198 Move xml.etree higher and xml.parsers.expat lower in the markup ToC.
I assume that most users looking at this page are looking for a library
to process XML, not a low-level parser.  First proposed in #11379.
2012-03-05 16:01:41 +01:00
Éric Araujo fdfaf0aba2 Use source reST role instead of file where it makes sense.
source generates a nifty link to the Mercurial web viewer.
2012-03-05 15:50:37 +01:00
Éric Araujo d3899e320f Remove mention of defunct file.
Misc/COPYRIGHT was renamed twelve years ago to LICENSE and later copied
to the main docs, to which there is already a link.
2012-03-05 15:47:32 +01:00
Antoine Pitrou 8d3c290de4 Issue #14166: Pickler objects now have an optional `dispatch_table` attribute which allows to set custom per-pickler reduction functions.
Patch by sbt.
2012-03-04 18:31:48 +01:00
Georg Brandl f125bf5f94 Update copyright years and version name. 2012-03-04 16:26:19 +01:00
Georg Brandl 0e475c359c Sort and clean up suspicious ignore file. 2012-03-04 16:22:05 +01:00
Georg Brandl a673eb895e Fix invalid markup and update suspicious ignores. 2012-03-04 16:17:05 +01:00
Georg Brandl 50fdcdf086 Fix encoding handling of the pydoc-topics writer. 2012-03-04 16:12:02 +01:00
Armin Ronacher 50364b4a5c Basic documentation for PEP 414 2012-03-04 12:33:51 +00:00
Victor Stinner 643cd68ea4 Issue #13964: signal.sigtimedwait() timeout is now a float instead of a tuple
Add a private API to convert an int or float to a C timespec structure.
2012-03-02 22:54:03 +01:00
Brett Cannon 83ac0133bd Clarify importlib.machinery.PathFinder's difference from what __import__() does. 2012-03-02 12:10:48 -05:00
Brett Cannon 75321e8379 Minor doc cleanup. 2012-03-02 11:58:25 -05:00
Eli Bendersky b2b18632ce merge 3.2 heads 2012-03-02 07:43:08 +02:00
Eli Bendersky 92818d5383 Merge 3.2 2012-03-02 07:41:23 +02:00
Eli Bendersky 20293441da Issue #11379: add a note in xml.dom.minidom suggesting to use etree in some cases 2012-03-02 07:37:13 +02:00
Petri Lehtinen be52d507d2 Merge branch '3.2'
Issue #13491.
2012-03-01 21:49:41 +02:00
Petri Lehtinen 4d2bfb5e08 sqlite3: Port documentation changes from the 2.7 branch
Issue #13491.
2012-03-01 21:48:38 +02:00
Eli Bendersky 493846e149 Add missing 'versionadded' for shlex.quote; closes #14165 2012-03-01 19:07:55 +02:00
Stefan Krah 54c32032aa Issue #10181: Add warning that structure layouts in memoryobject.h and
object.h have changed.
2012-02-29 17:47:21 +01:00
Stefan Krah 95b1ba6388 Add PyMemoryView_FromMemory() to whatsnew/3.3. 2012-02-29 17:27:21 +01:00
Ezio Melotti 6ea00ef25a #14155: merge with 3.2. 2012-02-29 13:40:11 +02:00
Ezio Melotti 443f000bdd #14155: remove duplication about search vs match in re doc. 2012-02-29 13:39:05 +02:00
Ezio Melotti 0b8123d8ae #10713: merge with 3.2. 2012-02-29 11:49:45 +02:00
Ezio Melotti 5a045b9f54 #10713: Improve documentation for \b and \B and add a few tests. Initial patch and tests by Martin Pool. 2012-02-29 11:48:44 +02:00
Larry Hastings 7b5649cd48 Merge: Propagate changes for issues #13053 and #13086 from 2.7 to 3.2.
(Doc only.)
2012-02-28 16:30:31 -08:00
Larry Hastings 62417a0354 Propagate changes for issues #13053 and #13086 from 2.7 to 3.2. (Doc only.) 2012-02-28 16:21:47 -08:00
Sandro Tosi 0109e3cd24 merge with 3.2 2012-02-28 22:29:08 +01:00
Sandro Tosi 83c48822c5 s/div/truediv/; thanks to Félix-Antoine Fortin from docs@ 2012-02-28 22:28:28 +01:00
Vinay Sajip ff4b7bfaef Merged cookbook improvement from 3.2. 2012-02-28 08:06:01 +00:00
Vinay Sajip 39b83ac772 Improved logging cookbook example. 2012-02-28 08:05:23 +00:00