Commit Graph

1588 Commits

Author SHA1 Message Date
Vinay Sajip 40d9a4e854 Improved logging.Formatter date/time formatting documentation. 2010-08-30 18:10:03 +00:00
Benjamin Peterson 6b4fa776ac rewrite and move open() docs only to functions.rst 2010-08-30 13:19:53 +00:00
Benjamin Peterson 4e4ffb1181 sync open() doc 2010-08-30 12:46:09 +00:00
Antoine Pitrou b530e1438b Issue #9715: improve documentation of the io module 2010-08-30 12:41:00 +00:00
Mark Dickinson 64a38c0eb5 Issue #1512791: In setframerate method of Wave_write, round non-integral
inputs to the nearest integer.  Thanks Neil Tallim for the patch.
2010-08-28 17:22:16 +00:00
Georg Brandl 816756182e #9681: typo. 2010-08-26 14:30:56 +00:00
Georg Brandl 179249f493 #9689: add links from overview to in-depth class API descriptions. 2010-08-26 14:30:15 +00:00
Brian Curtin 8790a07927 Fix #7579. Add docstrings to msvcrt and adjust some wording for bytes. 2010-08-24 05:20:30 +00:00
Benjamin Peterson 17689991e6 only catch AttributeError in hasattr() #9666 2010-08-24 03:26:23 +00:00
Georg Brandl 6a74da3cdb #9649: fix default value description. 2010-08-22 20:23:38 +00:00
Benjamin Peterson 2d55e2aab3 provide sample implementations for attrgetter and methodcaller 2010-08-21 20:08:36 +00:00
Benjamin Peterson c16f8b33e0 fix more indentation 2010-08-21 20:03:15 +00:00
Benjamin Peterson ffec810d88 indent properly 2010-08-21 20:01:28 +00:00
Senthil Kumaran 6cbe4275cb Add info about HTTP/1.1 and Connection:Close header. 2010-08-21 16:08:32 +00:00
Benjamin Peterson 23110e7361 alias macintosh to mac_roman #843590 2010-08-21 02:54:44 +00:00
Vinay Sajip 8101021eae Issue #9606: Updated documentation for Filter objects. 2010-08-19 19:17:41 +00:00
Victor Stinner e8d5145e18 Create os.fsdecode(): decode from the filesystem encoding with surrogateescape
error handler, or strict error handler on Windows.

 * Rewrite os.fsencode() documentation
 * Improve os.fsencode and os.fsdecode() tests using the new PYTHONFSENCODING
   environment variable
2010-08-19 01:05:19 +00:00
Andrew M. Kuchling 4ea04a306f #7647: add ST_RDONLY, ST_NOSUID constants to os module.
(Also fix a name ordering in the ACKS file.)
2010-08-18 22:30:34 +00:00
Éric Araujo 0fc86b86ed Fix indentation level 2010-08-18 22:29:54 +00:00
Éric Araujo f5be090bc3 Fix example 2010-08-17 21:24:05 +00:00
Antoine Pitrou cdfe1c54fc Add versionadded tags 2010-08-17 21:15:00 +00:00
Antoine Pitrou bf1a018ce4 Modernize gzip examples 2010-08-17 21:11:49 +00:00
Antoine Pitrou 79c5ef11d5 Issue #3488: Provide convenient shorthand functions `gzip.compress`
and `gzip.decompress`.  Original patch by Anand B. Pillai.
2010-08-17 21:10:05 +00:00
Raymond Hettinger 3fccfcb751 Minor rewording to docs for the lru_cache decorator 2010-08-17 19:19:29 +00:00
Benjamin Peterson 7ac98ae3b3 wrap 2010-08-17 17:52:02 +00:00
Giampaolo Rodolà 42382fedcc fix issue #8807: adds a context parameter to POP3_SSL class. 2010-08-17 16:09:53 +00:00
Giampaolo Rodolà ccfb91c89f fix issue #8866: parameters passed to socket.getaddrinfo can now be specified as single keyword arguments. 2010-08-17 15:30:23 +00:00
Georg Brandl 67b21b7547 Consistency check for versionadded/changed directives. 2010-08-17 15:07:14 +00:00
Georg Brandl 9e25701e87 Markup nits. 2010-08-17 14:11:59 +00:00
Nick Coghlan eae2da1da7 Issue 9147: Add dis.code_info() 2010-08-17 08:03:36 +00:00
Nick Coghlan 9887683f74 Document and test the resolution of issue 3445 (tolerate missing attributes in functools.update_wrapper, previously implemented as a side effect of the __annotations__ copying patch) and implement issue 9567 (add a __wrapped__ attribute when using update_wrapper) 2010-08-17 06:17:18 +00:00
Nick Coghlan 632a0c1476 Remove some lingering remnants of the short-lived functools.lfu_cache 2010-08-17 05:22:50 +00:00
Benjamin Peterson ad1e0c5e5f added versionadded 2010-08-17 03:37:20 +00:00
Benjamin Peterson 45c257f193 add support for abstract class and static methods #5867 2010-08-17 00:52:52 +00:00
Florent Xicluna e3c39ae53e Replace readfp() with read_file() in configparser documentation. 2010-08-15 20:21:26 +00:00
Florent Xicluna ac521078d7 Remove bad merge (from svnmerge r82301) 2010-08-14 18:03:19 +00:00
Georg Brandl 8e27fcea07 Wording fix. 2010-08-14 15:46:15 +00:00
Éric Araujo d7fc374a7a Oops, fix typo 2010-08-14 05:00:18 +00:00
Éric Araujo 71428876ea Fix reference (follow-up to #9061) 2010-08-14 04:55:45 +00:00
Antoine Pitrou 6fdb74f0ae Re-apply r83871. 2010-08-13 16:26:40 +00:00
Antoine Pitrou 6e451df800 Followup to r83869 and issue #8524: rename socket.forget() to socket.detach()
and make it return the file descriptor.
2010-08-09 20:39:54 +00:00
Senthil Kumaran f0769e8bd0 Fix Issue7007 - Use percent-encoded consistently instead of URL Encoded variations. Docs changed. 2010-08-09 19:53:52 +00:00
Fred Drake a492362f9a issue #9452:
Add read_file, read_string, and read_dict to the configparser API;
new source attribute to exceptions.
2010-08-09 12:52:45 +00:00
Antoine Pitrou f14c263280 Also temporarily revert r83871, to fix compilation on buildbots 2010-08-09 12:47:33 +00:00
Benjamin Peterson cca65313c4 use 3 space indents 2010-08-09 02:13:10 +00:00
Raymond Hettinger 5b0c1e07ca Issue 7846: fnmatch cache can grow without bound
Updated to solution to use the functools.lru_cache().
Restores the API so that purge() is not needed
(because the cache never gets big).
2010-08-09 02:07:15 +00:00
Antoine Pitrou e43f9d0ed6 Issue #8524: Add a forget() method to socket objects, so as to put the
socket into the closed state without closing the underlying file
descriptor.
2010-08-08 23:24:50 +00:00
Antoine Pitrou 696e03553b Issue #477863: Print a warning at shutdown if gc.garbage is not empty. 2010-08-08 22:18:46 +00:00
Florent Xicluna c17f17294f Issue #8047: Fix the xml.etree serializer to return bytes by default.
Use ``encoding="unicode"`` to generate a Unicode string.
2010-08-08 19:48:29 +00:00
Raymond Hettinger d331ce9e66 Issue #9507: Named tuple repr will now automatically display the right
name in a tuple subclass.
2010-08-08 01:13:42 +00:00
Raymond Hettinger a6b76ba52e Improve readability of collections docs by adding a summary table
at the top and by list concrete classes before abstract base classes.
2010-08-08 00:29:08 +00:00
Raymond Hettinger 648e725712 Fix typo 2010-08-07 23:37:37 +00:00
Raymond Hettinger 0e833c3227 Document implementation notes for priority queues 2010-08-07 23:31:27 +00:00
Raymond Hettinger 769b6d3009 Clean-up docstring in examples. 2010-08-07 21:31:55 +00:00
Raymond Hettinger 87c9d6cf9c Improve the docs for bisect to cover common searching tasks. 2010-08-07 07:36:55 +00:00
Raymond Hettinger 08d01eedef Add partition recipe to itertools docs. 2010-08-07 05:36:53 +00:00
Brian Curtin ef9efbd69c Fix #9324: Add parameter validation to signal.signal on Windows in order
to prevent crashes.
2010-08-06 19:27:32 +00:00
Gerhard Häring c34d76cdc3 Issue #3854: Documented using the sqlite3 module with multiple threads. 2010-08-06 06:12:05 +00:00
Brian Curtin f045d775fd Issue #9524: Document that two CTRL* signals are meant for use only
with os.kill.
2010-08-05 18:56:00 +00:00
Alexandre Vassalotti ae7801813c Issue 5077: Add documentation for operator fixer.
Patch by Meador Inge.
2010-08-05 07:12:18 +00:00
Mark Dickinson 74f5902b04 Issue #9498: Add reference to sys.float_info from 'numeric types' docs.
Thanks Yitz Gale.
2010-08-04 18:42:43 +00:00
Antoine Pitrou 560f7647ce Issue #8814: function annotations (the `__annotations__` attribute)
are now included in the set of attributes copied by default by
functools.wraps and functools.update_wrapper.  Patch by Terrence Cole.
2010-08-04 18:28:02 +00:00
Senthil Kumaran 84c7d9f87b Fix Issue754016 - urlparse goes wrong with IP:port without scheme 2010-08-04 04:50:44 +00:00
R. David Murray 88c49fe320 #9444: use first of prefix_chars for help opt instead of raising error
An argparse option parser created with a prefix_chars that did not
include a '-' would happily add -h and --help options, and then throw
an error when it tried to format the help because the - was an invalid
prefix character.  This patch makes it use the first character of
prefix_chars as the character for the help options if and only if '-'
is not one of the valid prefix_chars.

Fix by Theodore Turocy, unit tests by Catherine Devlin.
2010-08-03 17:56:09 +00:00
Georg Brandl 7cb1319688 Terminology fix: exceptions are raised, except in generator.throw(). 2010-08-03 12:06:29 +00:00
Georg Brandl 1800934285 #9061: warn that single quotes are never escaped. 2010-08-02 21:51:18 +00:00
Georg Brandl 98be996250 #9238: zipfile does handle archive comments. 2010-08-02 20:52:10 +00:00
Georg Brandl 62e4231a27 #7797: be explicit about bytes-oriented interface of base64 functions. 2010-08-02 20:39:35 +00:00
Georg Brandl a1631b337a #9019: remove false (in 3k) claim about Headers updates. 2010-08-02 20:30:57 +00:00
Georg Brandl b2566cfbf9 #9111: document that do_help() looks at docstrings. 2010-08-02 20:27:20 +00:00
Georg Brandl 0c7ade2fe3 Remove redundant information. 2010-08-02 19:39:17 +00:00
Georg Brandl c589a70e17 #9438: clarify that constant names also cannot be assigned as attributes. 2010-08-02 19:36:36 +00:00
Georg Brandl 9499bb76a3 Remove XXX comment that was displayed. 2010-08-02 19:35:06 +00:00
Georg Brandl 7528b9b8ac #8172: how does one use a property? 2010-08-02 19:23:34 +00:00
Georg Brandl 353ebce2a0 #7386: add example that shows that trailing path separators are stripped. 2010-08-02 19:19:26 +00:00
Senthil Kumaran 790f831648 Rewording the getheader method of HTTPResponse. 2010-08-02 17:09:02 +00:00
Senthil Kumaran 9f8dc4441f Fix Issue8572 - httplib getheader() throws error instead of default 2010-08-02 11:04:58 +00:00
Raymond Hettinger c8dc62d602 Add example applications for the LRU and LFU cache docs. 2010-08-02 00:59:14 +00:00
Georg Brandl 0bccc185b4 #8046: add context manager protocol support to mmap objects. Also add closed property. 2010-08-01 14:50:00 +00:00
Georg Brandl 0941012325 #8735: better explain semantics of *values* argument for parse(). 2010-08-01 06:53:28 +00:00
Georg Brandl bb1901529d Fix "Berkeley" name. 2010-07-31 21:41:42 +00:00
Georg Brandl 6cb7b6593e #1286: allow using fileinput.FileInput as context manager. 2010-07-31 20:08:15 +00:00
Georg Brandl e42a59daec #9442: do not document a specific format for sys.version; rather refer to version_info and the platform module. 2010-07-31 20:05:31 +00:00
Georg Brandl 721507b315 #5778: document that sys.version can contain a newline. 2010-07-31 19:59:55 +00:00
Georg Brandl 2e7346acc9 Re-commit r83327 now that the release is done. 2010-07-31 18:09:23 +00:00
Georg Brandl f55c31594b #9430: document timedelta str() and repr(). 2010-07-31 11:40:07 +00:00
Georg Brandl 014e0ca58e Revert r83327. This will have to wait until after the alpha1 release. 2010-07-31 10:16:21 +00:00
Raymond Hettinger 4821ef89d4 Document how to change OrderedDict update order from first to last. 2010-07-31 10:14:41 +00:00
Raymond Hettinger 9e46ef819c Add functools.lfu_cache() and functools.lru_cache(). 2010-07-31 10:11:39 +00:00
Georg Brandl 0a9c3e91dc Show the traceback line numbers as well as the current line numbers if an exception is being debugged. Courtesy of pdb++ by Antonio Cuni. Also document -> and >> markers for "list". 2010-07-30 18:46:38 +00:00
Georg Brandl e59ca2afe3 Add "longlist" and "source" commands, ideas borrowed from pdb++ by Antonio Cuni. 2010-07-30 17:04:28 +00:00
Georg Brandl d2fd4cae8e Add Breakpoint.bpformat(), which returns the info usually printed by bpprint(). Necessary for major refactoring of pdb output handling. 2010-07-30 15:01:23 +00:00
Mark Dickinson c4fbcdc4c8 Add note about surprising behaviour from round function. 2010-07-30 13:13:02 +00:00
Georg Brandl 7410dd11ef #809887: improve pdb feedback for breakpoint-related actions. Also add a functional test for these commands. 2010-07-30 12:01:20 +00:00
Georg Brandl 46b9afc862 #1472251: remove addition of "\n" to code given to pdb.run[eval](), the bug in exec() that made this necessary has been fixed. Also document that you can give code objects to run() and runeval(), and add some tests to test_pdb. 2010-07-30 09:14:20 +00:00
Georg Brandl 26a0f87e28 Document the "jump" command in pdb.__doc__, and add a version tag for "until X". 2010-07-30 08:45:26 +00:00
Georg Brandl 2dfec552fe Allow giving an explicit line number to "until". 2010-07-30 08:43:32 +00:00
Georg Brandl e023091815 #1437051: allow "continue"/"next"/etc. in .pdbrc, also add pdb -c option to give these commands. This allows to run a script until an exception occurs. 2010-07-30 08:29:39 +00:00
Georg Brandl b3b96bd520 Clarification. 2010-07-30 07:03:39 +00:00
Georg Brandl 056cb93e7a #6630: allow customizing flags for compiling string.Template.idpattern. 2010-07-29 17:16:10 +00:00
Georg Brandl 8a1caa2361 #6522: add a "decorator" directive to explicitly document decorators, and use it in a few places. 2010-07-29 16:01:11 +00:00
Georg Brandl b0a4e3c1a7 #9388: remove ERA_YEAR which is never defined in the source code. 2010-07-29 14:49:08 +00:00
Georg Brandl ac958ce05e #9397: remove mention of dbm.bsd which does not exist anymore. 2010-07-29 14:46:07 +00:00
Georg Brandl 933b974a41 Use correct directive and name. 2010-07-29 14:36:11 +00:00
Georg Brandl 436ccdc7e7 #9407: document configparser.Error. 2010-07-29 14:32:22 +00:00
Georg Brandl 470a123910 #1090076: explain the behavior of *vars* in get() better. 2010-07-29 14:17:12 +00:00
Georg Brandl 46aa5c5ba1 #3874: document HTMLParser.unknown_decl(). 2010-07-29 13:38:37 +00:00
Georg Brandl 8dcaa7396f #9411: allow selecting an encoding for configparser files. Also adds a new test config file to test special cases. 2010-07-29 12:17:40 +00:00
Georg Brandl c62a704189 #6538: fix regex documentation again -- use fictional class names "regex" and "match" but do not document them as classes, remove 1.5 compat info and use new default argument syntax where possible. 2010-07-29 11:49:05 +00:00
Georg Brandl ebeb44d8d3 Remove Python 1.5 compatibility note. 2010-07-29 11:15:36 +00:00
Georg Brandl 96a60ae90c #1682942: add some ConfigParser features: alternate delimiters, alternate comments, empty lines in values. Also enhance the docs with more examples and mention SafeConfigParser before ConfigParser. Patch by Lukas Langa, review by myself, Eric and Ezio. 2010-07-28 13:13:46 +00:00
Florent Xicluna f1046ca817 Issue #4770: Restrict binascii module to accept only bytes (as specified).
And fix the email package to encode to ASCII instead of ``raw-unicode-escape`` before ASCII-to-binary decoding.
2010-07-27 21:20:15 +00:00
Alexander Belopolsky c02cc2707a Issue #9384: python -m tkinter will now display a simple demo applet. 2010-07-27 14:16:32 +00:00
Alexander Belopolsky f39f62802d Added versionadded entry for the annotate argument. 2010-07-26 18:27:49 +00:00
Georg Brandl 571a953590 Fix indentation in example. 2010-07-26 17:00:20 +00:00
Andrew M. Kuchling 3f911a16db Reword paragraph 2010-07-26 13:08:58 +00:00
Andrew M. Kuchling 57a7c3df85 #7637: fix a grammar error; simplify a sentence 2010-07-26 12:54:02 +00:00
Andrew M. Kuchling ea64a6a4ca #7637: clarify description of encoding parameter 2010-07-25 23:23:30 +00:00
Andrew M. Kuchling 4d4d1ce7a7 #1495229: update the type names used by the XML DOM mapping 2010-07-25 22:57:12 +00:00
Martin v. Löwis 9c71f90329 Put listdir default argument into declaration. 2010-07-24 10:09:11 +00:00
Richard Jones 803ef8a694 Implementation for issue 4184
Changes the previously private attributes to make them public, increasing the potential for extending the library in user code. Backward-compatible and documented.
2010-07-24 09:51:40 +00:00
Brett Cannon 030244aaf9 Mention in the fnmatch docs that meta-characters in translate cannot be quoted.
Closes issue 9358. Thanks to Brian Brazil for the patch.
2010-07-23 16:58:21 +00:00
Georg Brandl a5eacee237 Fix some markup glitches. 2010-07-23 16:55:26 +00:00
Brett Cannon a57edd0e9e Clarify the wording for threading.is_alive() to not suggest something is
"roughly" done.

Closes issue 9339. Thanks Brian Brazil for the patch.
2010-07-23 12:26:35 +00:00
Martin v. Löwis c9e1c7d97f Issue #6095: Make directory argument to os.listdir optional.
Patch by Virgil Dupras.
2010-07-23 12:16:41 +00:00
Brett Cannon 3a4e50cb7e Document the fact that the 'test' package is meant only for use by Python
itself and not by others.

Closes issue 9255.
2010-07-23 11:31:31 +00:00
Antoine Pitrou de5b02430b Remove outdated mention of deprecated functions in the string module - they have been removed in 3.x. 2010-07-21 15:54:48 +00:00
Brett Cannon 6dfbff3ff3 Minor clarification about importlib.abc.SourceLoader.get_filename. 2010-07-21 09:48:31 +00:00
Georg Brandl 55353ca6dc pydoc.pager does not promise to use $PAGER. 2010-07-19 08:02:46 +00:00
Georg Brandl 70f355d13e Clarify. 2010-07-19 06:52:35 +00:00
Jean-Paul Calderone 7f54dce9bd Document the extra epoll flags 2010-07-18 16:30:31 +00:00
Jean-Paul Calderone 7f94f392a0 There is no method named "register(fd, eventmask)"; fix markup to just indicate this is code. 2010-07-18 16:13:27 +00:00
Benjamin Peterson d319ad5c1a nest method and attribute doc 2010-07-18 14:27:02 +00:00
Benjamin Peterson 0b9fb808a0 use classmethod 2010-07-18 14:23:36 +00:00
Georg Brandl 86e78d1f2d #9110: update to ContextDecorator doc. 2010-07-18 13:43:32 +00:00
Georg Brandl 02053ee3b9 #9279: remove the pdb.doc file, put its contents in pdb.__doc__. Also sync this and the pdb docs, introduce a new directive for pdb commands and a role to link to them. 2010-07-18 10:11:03 +00:00
Alexander Belopolsky 929d384058 Issue #9268: Add annotation option to pickletools.dis 2010-07-17 15:51:21 +00:00
Stefan Krah fc9e08de3a High byte is the exit status. 2010-07-14 10:16:11 +00:00
Georg Brandl e767e047c8 #9258: fix copy-paste errors. 2010-07-14 08:00:22 +00:00
Jeroen Ruigrok van der Werven 9c558bcfd1 Fix documentation typo: wprite() -> write(). 2010-07-13 14:47:01 +00:00
Georg Brandl 85f2177f6d Add bytes in literal_eval doc. 2010-07-13 06:38:10 +00:00
Antoine Pitrou c779515a75 Fix definition of len() and indexing for memoryview objects (part of #7696). 2010-07-12 20:01:52 +00:00
Georg Brandl db4e939206 Use raw string literals for regexes containing backlash. 2010-07-12 09:06:13 +00:00
Mark Dickinson c762242cca Include versionadded in (c)math.isfinite docs (thanks Ezio Melotti). Other minor doc cleanups. 2010-07-11 19:47:37 +00:00
Mark Dickinson 8e0c996873 Issue #9165: Add math.isfinite and cmath.isfinite. 2010-07-11 17:38:24 +00:00
Georg Brandl 05bfcc590d #7935: cross-reference to ast.literal_eval() from eval() docs. 2010-07-11 09:42:10 +00:00
Georg Brandl 492f3fc272 Allow set literals in literal_eval(). 2010-07-11 09:41:21 +00:00
Georg Brandl e40ee509e3 #9184: fix default value for "buffering" param of open(). 2010-07-11 09:33:39 +00:00
Georg Brandl 0104bcdb80 #6774: explain shutdown() behavior varying with platform. 2010-07-11 09:23:11 +00:00
Senthil Kumaran aba088e01d Issue2007: Removing reference to MSIE Cookie handling by mechanize. Suggested by John J Lee. 2010-07-11 05:01:52 +00:00