Commit Graph

4365 Commits

Author SHA1 Message Date
Martin v. Löwis 05c075d629 Bug #1115886: os.path.splitext('.cshrc') gives now ('.cshrc', ''). 2007-03-07 11:04:33 +00:00
Georg Brandl f08c073ded Patch #1669331: clarify shutil.copyfileobj() behavior wrt. file position. 2007-03-07 09:34:45 +00:00
Georg Brandl d0a962506b Patch #787789: allow to pass custom TestRunner instances to unittest's
main() function.
2007-03-07 09:21:06 +00:00
George Yoshida cadbbfc85b add versionadded info 2007-03-07 04:21:18 +00:00
Martin v. Löwis ab8a6bba25 Patch #912410: Replace HTML entity references for attribute values
in HTMLParser.
2007-03-06 14:43:00 +00:00
Georg Brandl ff432e6f4a Patch #1663234: you can now run doctest on test files and modules
using "python -m doctest [-v] filename ...".
2007-03-06 13:37:45 +00:00
Martin v. Löwis 3eb7648986 Patch #1121142: Implement ZipFile.open. 2007-03-06 10:41:24 +00:00
Raymond Hettinger c37e5e04eb Add collections.NamedTuple 2007-03-01 06:16:43 +00:00
Andrew M. Kuchling f2ae27e61a Markup fix 2007-02-26 23:02:47 +00:00
Jeremy Hylton 759410b372 Do not copy free variables to locals in class namespaces.
Fixes bug 1569356, but at the cost of a minor incompatibility in
locals().  Add test that verifies that the class namespace is not
polluted.  Also clarify the behavior in the library docs.

Along the way, cleaned up the dict_to_map and map_to_dict
implementations and added some comments that explain what they do.
2007-02-26 18:41:18 +00:00
Fred Drake 5a3e812444 - SF patch #1657613: add documentation for the Element interface
- clean up bogus use of the {datadescni} environment everywhere
2007-02-25 17:56:27 +00:00
Raymond Hettinger d36862cf78 Add itertools.izip_longest(). 2007-02-21 05:20:38 +00:00
Raymond Hettinger cbac8ce5b0 Fixup docstrings for merge(). 2007-02-19 18:15:04 +00:00
Martin v. Löwis 382abeff0f Patch #1490190: posixmodule now includes os.chflags() and os.lchflags()
functions on platforms where the underlying system calls are available.
2007-02-19 10:55:19 +00:00
Raymond Hettinger bcc40ba922 Provide an example of defaultdict with non-zero constant factory function. 2007-02-19 09:14:10 +00:00
Raymond Hettinger 00166c5532 Add merge() function to heapq. 2007-02-19 04:08:43 +00:00
Georg Brandl 9cb37fc5d0 Add missing \versionadded. 2007-02-15 11:29:55 +00:00
Georg Brandl 983d100202 Patch #1494140: Add documentation for the new struct.Struct object. 2007-02-15 11:29:04 +00:00
Georg Brandl 9dca5eaf57 Make functools.wraps() docs a bit clearer. 2007-02-15 10:37:59 +00:00
Martin v. Löwis 91670d0246 Bug #1658794: Remove extraneous 'this'.
Will backport to 2.5.
2007-02-13 12:08:24 +00:00
Martin v. Löwis 84f6de9d7e Patch #1517891: Make 'a' create the file if it doesn't exist.
Fixes #1514451.
2007-02-13 10:10:39 +00:00
Martin v. Löwis c6d626ed9f Patch #698833: Support file decryption in zipfile. 2007-02-13 09:49:38 +00:00
Lars Gustäbel a69aa327aa Bug #1656581: Point out that external file objects are supposed to be
at position 0.
2007-02-12 09:25:53 +00:00
Georg Brandl 441268f867 Bug #1656078: typo in in profile docs. 2007-02-09 18:48:41 +00:00
Martin v. Löwis 7c4615b252 Update broken link. Will backport to 2.5. 2007-02-09 12:58:49 +00:00
Raymond Hettinger 3156316823 SF: 1397711 Set docs conflated immutable and hashable 2007-02-07 21:04:20 +00:00
Lars Gustäbel 3f8aca1164 Patch #1652681: create nonexistent files in append mode and
allow appending to empty files.
2007-02-06 18:38:13 +00:00
Brett Cannon 129bd52146 No more raising of string exceptions!
The next step of PEP 352 (for 2.6) causes raising a string exception to trigger
a TypeError.  Trying to catch a string exception raises a DeprecationWarning.
References to string exceptions has been removed from the docs since they are
now just an error.
2007-01-30 21:34:36 +00:00
Georg Brandl a05153683c Bug #1648191: typo in docs. 2007-01-30 20:21:30 +00:00
Andrew M. Kuchling 391e917b1a Strengthen warning about using lock() 2007-01-24 20:06:41 +00:00
Martin v. Löwis aef4c6bc00 Patch #1610575: Add support for _Bool to struct. 2007-01-21 09:33:07 +00:00
Raymond Hettinger 1b0ce85271 SF# 1635892: Fix docs for betavariate's input parameters . 2007-01-19 18:07:18 +00:00
Andrew M. Kuchling 3ffcfe2f68 [Part of bug #1599254] Add suggestion to Mailbox docs to use Maildir, and warn user to lock/unlock mailboxes when modifying them 2007-01-17 19:55:06 +00:00
Brett Cannon f5c034af10 Add a note for strptime that just because strftime supports some extra
directive that is not documented that strptime will as well.
2007-01-15 19:12:08 +00:00
Guido van Rossum 2799aab86d Doc patch matching r53434 (htonl etc. now always take/return positive ints). 2007-01-15 00:02:35 +00:00
Vinay Sajip 1ff01fb0af Added documentation for WatchedFileHandler (based on SF patch #1598415) 2007-01-14 21:50:50 +00:00
Georg Brandl 7ded34d25e Fix typo. 2007-01-13 12:31:51 +00:00
Brett Cannon 093b67061a Deprecate the sets module. 2007-01-13 00:29:49 +00:00
Brett Cannon 78a132b814 Fix error where the end of a funcdesc environment was accidentally moved too
far down.
2007-01-12 07:27:52 +00:00
Matthias Klose 764a7ec8ca - Make the documentation match the code and the docstring 2007-01-11 10:26:31 +00:00
Gregory P. Smith d92d3c7197 typo fix 2007-01-05 07:21:35 +00:00
Gregory P. Smith 8b96a35d14 Support linking of the bsddb module against BerkeleyDB 4.5.x
(will backport to 2.5)
2007-01-05 01:59:42 +00:00
Brett Cannon 92d54d5e9c Add EnvironmentVarGuard to test.test_support. Provides a context manager to
temporarily set or unset environment variables.
2007-01-04 00:23:49 +00:00
Thomas Heller d5624cf6c9 Fix wrong markup of an argument in a method signature.
Will backport.
2006-12-21 18:30:56 +00:00
Andrew M. Kuchling 4a8d272dca Mention the os.SEEK_* constants 2006-12-21 13:40:29 +00:00
Andrew M. Kuchling 2dd7c8c41e [Bug #1619680] in_dll() arguments are documented in the wrong order 2006-12-20 20:20:42 +00:00
Andrew M. Kuchling a490d59fbb Some other built-in functions are described with 'sequence' arguments
that should really be 'iterable'; this commit changes them.

Did I miss any?  Did I introduce any errors?
2006-12-20 20:11:12 +00:00
Andrew M. Kuchling b688573766 Two grammar fixes 2006-12-20 19:58:11 +00:00
Andrew M. Kuchling 1be2ac9cd6 [Bug #1619674] Make sum() use the term iterable, not sequence 2006-12-20 19:57:10 +00:00
Georg Brandl ebbeed781d Patch #1484695: The tarfile module now raises a HeaderError exception
if a buffer given to frombuf() is invalid.
2006-12-19 22:06:46 +00:00
Vinay Sajip 8183c635bc Updated documentation for findCaller() to indicate that a 3-tuple is now returned, rather than a 2-tuple. 2006-12-19 18:29:11 +00:00
Andrew M. Kuchling 64df22bdb5 [Bug #1613651] Document socket.recv_into, socket.recvfrom_into
Also, the text for recvfrom told you to read recv() for an explanation of the
'flags' argument, but recv() just pointed you at the man page.  Copied the
man-page text to recvfrom(), recvfrom_into, recv_into to avoid the pointless
redirection.

I don't have LaTeX on this machine; hope my markup is OK.
2006-12-19 14:28:23 +00:00
Andrew M. Kuchling 4cd69d43e8 [Bug #1618083] Add missing word; make a few grammar fixes 2006-12-18 17:12:31 +00:00
George Yoshida 7366fcecdf Note that guard_warnings_filter was added in 2.6 2006-12-14 02:22:44 +00:00
Brett Cannon 6d9520c4f0 Add test.test_support.guard_warnings_filter . This function returns a context
manager that protects warnings.filter from being modified once the context is
exited.
2006-12-13 23:09:53 +00:00
Neal Norwitz 0adf0846ce Fix a typo 2006-12-11 01:01:06 +00:00
Matthias Klose ebde1498e7 - Fix the build of the library reference in info format. 2006-12-09 12:15:27 +00:00
Georg Brandl 70f466932c RFE #1592899: mention string.maketrans() in docs for str.translate,
remove reference to the old regex module in the former's doc.
2006-12-07 09:30:06 +00:00
George Yoshida 0a286d0b53 Fix pickle doc typo
Patch #1608758
2006-12-05 05:39:50 +00:00
George Yoshida 9be4905f42 fix a versionchanged tag 2006-12-04 11:41:54 +00:00
Martin v. Löwis a00bcac003 Patch #1371075: Make ConfigParser accept optional dict type
for ordering, sorting, etc.
2006-12-03 12:01:53 +00:00
Georg Brandl 73e7e058f5 Bug #1603789: grammatical error in Tkinter docs. 2006-11-27 18:46:21 +00:00
Georg Brandl 3f969022c6 Bug #1601630: little improvement to getopt docs 2006-11-23 09:55:07 +00:00
Neal Norwitz 7ac039653e Fix SF #1599879, socket.gethostname should ref getfqdn directly. 2006-11-21 06:23:44 +00:00
Georg Brandl 1e753863b3 Further markup fix. 2006-11-20 07:12:58 +00:00
George Yoshida 942f5e7864 markup fix 2006-11-20 02:24:48 +00:00
Martin v. Löwis 07529354db Patch #1070046: Marshal new-style objects like InstanceType
in xmlrpclib.
2006-11-19 18:51:54 +00:00
Georg Brandl 540821183b Bug #1597824: return the registered function from atexit.register()
to facilitate usage as a decorator.
2006-11-16 16:50:59 +00:00
Georg Brandl adff8eb8d6 Bug #1597576: mention that the new base64 api has been introduced in py2.4. 2006-11-16 15:05:14 +00:00
Martin v. Löwis 056dac1bcf Bug #1067760: Deprecate passing floats to file.seek. 2006-11-12 18:24:26 +00:00
Martin v. Löwis 040a927cd1 Patch #1065257: Support passing open files as body in
HTTPConnection.request().
2006-11-12 10:32:47 +00:00
Georg Brandl 1ee79f16e8 Bug #1594758: wording improvement for dict.update() docs. 2006-11-11 18:32:47 +00:00
Georg Brandl 361bc21c51 Bug #1594742: wrong word in stringobject doc. 2006-11-11 18:29:11 +00:00
Andrew M. Kuchling 48b1007542 [Feature request #1542920] Link to wsgi.org 2006-11-10 14:39:01 +00:00
Georg Brandl fafdc3b97b Bug #1592533: rename variable in heapq doc example, to avoid shadowing
"sorted".
2006-11-08 10:04:29 +00:00
Thomas Heller 9bfc24481f Fix grammatical error as well.
Will backport to release25-maint.
2006-11-07 18:20:47 +00:00
Thomas Heller a2dd0f3a17 Fix markup.
Will backport to release25-maint.
2006-11-07 18:01:18 +00:00
Skip Montanaro 3230599329 note that user can control directory location even if default dir is used 2006-11-06 14:34:52 +00:00
Thomas Heller be1bc3b63a Fix a code example by adding a missing import.
Fixes #1557890.

Will backport to release25-maint.
2006-11-02 20:22:29 +00:00
Thomas Heller b11472358f Replace the XXX marker in the 'Arrays and pointers' reference manual
section with a link to the tutorial sections.

Will backport to release25-maint.
2006-11-02 19:48:24 +00:00
Vinay Sajip 12411005e3 Added relativeCreated to Formatter doc (has been in the system for a long time - was unaccountably left out of the docs and not noticed until now). 2006-10-31 17:34:31 +00:00
Neal Norwitz 4bb9b56501 From SF 1557890, fix problem of using wrong type in example.
Will backport.
2006-10-28 22:12:26 +00:00
Georg Brandl 35692a0c0e Fix nth() itertool recipe. 2006-10-28 16:04:04 +00:00
Andrew M. Kuchling d3aad0199e Point users to the subprocess module in the docs for os.system, os.spawn*, os.popen2, and the popen2 and commands modules 2006-10-27 14:53:41 +00:00
Andrew M. Kuchling 4bc64aaef7 [Bug #1562583] Mention the set_reuse_addr() method 2006-10-27 13:06:25 +00:00
Andrew M. Kuchling 14b0cab5d5 [Bug #1583946] Reword description of server and issuer 2006-10-27 12:50:38 +00:00
Andrew M. Kuchling 514d0cf40e [Bug #1585690] Note that line_num was added in Python 2.5 2006-10-27 12:18:38 +00:00
Andrew M. Kuchling 1192044445 Some wording changes and markup fixes 2006-10-27 11:37:01 +00:00
Martin v. Löwis ee82c0e6b7 Patch #1567274: Support SMTP over TLS. 2006-10-27 07:13:28 +00:00
Ronald Oussoren 10168f25ad Patch #1580674: with this patch os.readlink uses the filesystem encoding to
decode unicode objects and returns an unicode object when the argument is one.
2006-10-22 10:45:18 +00:00
Brett Cannon 5a72372329 Clean up the language of a sentence relating to the connect() function and
user-defined datatypes.
2006-10-14 06:36:45 +00:00
Georg Brandl a9969a6460 Small grammar fix, thanks Sjoerd. 2006-10-12 11:59:27 +00:00
Georg Brandl 10f0f691d3 Add a note to fpectl docs that it's not built by default
(bug #1556261).
2006-10-12 11:41:11 +00:00
Georg Brandl 7d74a0e287 Bug #1546628: add a note about urlparse.urljoin() and absolute paths. 2006-10-12 11:14:40 +00:00
Georg Brandl fc8375748a Bug #1575746: fix typo in property() docs. 2006-10-12 07:38:04 +00:00
Skip Montanaro fe6e46d42a Note that the excel_tab class is registered as the "excel-tab" dialect.
Fixes 1572471.  Make a similar change for the excel class and clean up
references to the Dialects and Formatting Parameters section in a few
places.
2006-10-07 11:05:02 +00:00
Andrew M. Kuchling c536a64b89 Case fix 2006-10-06 10:41:01 +00:00
Fred Drake 3c108b0e44 - update links
- remove Sleepycat name now that they have been bought
2006-10-06 00:03:45 +00:00
Brett Cannon 710513ef83 Clarify what "re-initialization" means for init_builtin() and init_dynamic().
Also remove warning about re-initialization as possibly raising an execption as
both call _PyImport_FindExtension() which pulls any module that was already
imported from the Python process' extension cache and just copies the __dict__
into the module stored in sys.modules.
2006-10-05 22:02:31 +00:00
Vinay Sajip f4686f995e Documentation clarified to mention optional parameters. 2006-10-03 18:20:26 +00:00
Vinay Sajip cfbb7df4b0 Documentation omitted the additional parameter to LogRecord.__init__ which was added in 2.5. (See SF #1569622). 2006-10-03 18:02:37 +00:00
Georg Brandl fb25773862 Bug #1566663: remove obsolete example from datetime docs. 2006-09-30 09:06:45 +00:00
Fred Drake 13782a3359 revise explanation of returns_unicode to reflect bool values
and to include the default value
(merged from release25-maint revision 51890)
2006-09-15 16:11:27 +00:00
Fred Drake a58f123602 - fix module name in links in formatted documentation
- minor markup cleanup
(forward-ported from release25-maint revision 51888)
2006-09-15 15:18:04 +00:00
Georg Brandl c9ded90368 Correct elementtree module index entry. 2006-09-15 05:22:24 +00:00
Ka-Ping Yee cdf6afde1a Fix grammar errors and improve clarity. 2006-09-15 00:34:19 +00:00
Andrew M. Kuchling ab856873f1 More wordsmithing 2006-09-12 21:21:51 +00:00
Andrew M. Kuchling 32cec80b02 Some editing, markup fixes 2006-09-12 21:09:02 +00:00
Andrew M. Kuchling abd5520cff Markup typo fix 2006-09-12 20:50:23 +00:00
Andrew M. Kuchling af57f6065f Fix typo in example 2006-09-08 14:05:10 +00:00
Andrew M. Kuchling 6d75567238 Use native SQLite types 2006-09-08 14:03:01 +00:00
Andrew M. Kuchling 2b46434109 Explain SQLite a bit more clearly 2006-09-08 13:36:36 +00:00
Georg Brandl c48c9e266f Bug #1552618: change docs of dict.has_key() to reflect recommendation
to use "in".
2006-09-05 12:44:58 +00:00
Raymond Hettinger a0c95fa4d8 Fix endcase for str.rpartition() 2006-09-04 15:32:48 +00:00
Nick Coghlan 5a901c62cc Typo fix for decimal docs 2006-09-03 01:06:07 +00:00
Nick Coghlan f1f42d850f Fix final documentation nits before backporting decimal module fixes to 2.5 2006-09-03 01:02:00 +00:00
Raymond Hettinger 68b6d3b85a Fix documentation nits for decimal context managers. 2006-09-02 17:07:23 +00:00
Nick Coghlan e7877d930c Further corrections to the decimal module context management documentation 2006-09-02 04:04:18 +00:00
Fred Drake eef345aa97 - SF patch #1550263: Enhance and correct unittest docs
- various minor cleanups for improved consistency
2006-09-01 03:57:19 +00:00
Nick Coghlan 8b6999b4c5 Fix the wrongheaded implementation of context management in the decimal module and add unit tests. (python-dev discussion is ongoing regarding what we do about Python 2.5) 2006-08-31 12:00:43 +00:00
Armin Rigo f580b104a4 Doc fix: hashlib objects don't always return a digest of 16 bytes.
Backport candidate for 2.5.
2006-08-31 08:51:06 +00:00
Anthony Baxter c85578725b patch for documentation for recent uuid changes (from ping) 2006-08-22 07:36:59 +00:00
Thomas Heller f5af05a211 Tutorial:
Clarify somewhat how parameters are passed to functions
    (especially explain what integer means).

    Correct the table - Python integers and longs can both be used.
    Further clarification to the table comparing ctypes types, Python
    types, and C types.

Reference:

    Replace integer by C ``int`` where it makes sense.
2006-08-16 18:02:11 +00:00
Marc-André Lemburg 040f76b79c Slightly revised version of patch #1538956:
Replace UnicodeDecodeErrors raised during == and !=
compares of Unicode and other objects with a new
UnicodeWarning.

All other comparisons continue to raise exceptions.
Exceptions other than UnicodeDecodeErrors are also left
untouched.
2006-08-14 10:55:19 +00:00
Andrew M. Kuchling 30c0d1d174 Reword paragraph to clarify 2006-08-08 18:50:14 +00:00
Georg Brandl 212b587a52 Patch #1534922: correct and enhance unittest docs. 2006-08-05 06:10:54 +00:00
Andrew M. Kuchling f4152c3215 Fix mangled sentence 2006-08-04 21:10:03 +00:00
Gregory P. Smith d856ce0a1f fix typos 2006-08-04 05:17:47 +00:00
Thomas Heller 5c387f2e5d Fix a mistake. 2006-08-02 12:00:13 +00:00
Thomas Heller 6a0ce407fb A few nore words about what ctypes does.
Document that using the wrong calling convention can also raise
'ValueError: Procedure called with the wrong number of arguments'.
2006-08-02 11:35:31 +00:00
Andrew M. Kuchling b7697a50fb [Bug #848556] Remove \d* from second alternative to avoid exponential case when repeating match 2006-07-31 16:22:05 +00:00
Andrew M. Kuchling aa95fdb783 [Bug #1514540] Instead of putting the standard types in a section, put them in a chapter of their own. This means string methods will now show up in the ToC. (Should the types come before or after the functions+exceptions+constants chapter? I've put them after, for now.) 2006-07-31 16:10:24 +00:00
Andrew M. Kuchling ec3a89449e Remove reference to notation 2006-07-31 15:23:43 +00:00
Andrew M. Kuchling 17159fe26f Typo fix 2006-07-31 15:22:58 +00:00
Skip Montanaro 759c185ce0 minor tweaks 2006-07-31 03:11:11 +00:00
Skip Montanaro 08bbccf369 minor tweaks 2006-07-31 03:09:45 +00:00
Andrew McNamara 10183b8e40 Redo the comment about the 2.5 change in quoted-newline handling. 2006-07-31 02:27:48 +00:00
Georg Brandl e34ac7ce7a Bug #1002398: The documentation for os.path.sameopenfile now correctly
refers to file descriptors, not file objects.
2006-07-30 11:07:23 +00:00
Fred Drake 33c3e29fce - remove yet another reference to how commonly Tkinter is (thought to be) used
- fix an internal section reference
2006-07-30 05:55:39 +00:00
Fred Drake 21731118af remove possibly-outdated comment on what GUI toolkit is most commonly used;
it is hard to know whether this is right, and it does not add valuable reference information
at any rate
2006-07-30 05:49:49 +00:00
Fred Drake c3c805e8b2 update information on wxPython, from Robin Dunn 2006-07-30 05:41:28 +00:00
Fred Drake e0d4aecfc2 lots of markup nits, most commonly Unix/unix --> \UNIX 2006-07-30 03:03:43 +00:00
Andrew M. Kuchling ad416d056f [Bug #793553] Correct description of keyword arguments for SSL authentication 2006-07-30 00:37:56 +00:00
Fred Drake d457a97beb markup cleanups 2006-07-29 23:34:57 +00:00
Andrew M. Kuchling 2d5c8e3bb1 Fix case for 'Unix' 2006-07-29 21:30:21 +00:00
Andrew M. Kuchling b9a79c95dc Follow TeX's conventions for hyphens 2006-07-29 21:27:12 +00:00
Fred Drake a650fb3d6f fix minor markup error that introduced extra punctuation 2006-07-29 20:21:25 +00:00
Skip Montanaro abd51a3585 Add a comment to the csv reader documentation that explains why the
treatment of newlines changed in 2.5.  Pulled almost verbatim from a comment
by Andrew McNamara in <http://python.org/sf/1465014>.
2006-07-29 20:06:05 +00:00
Fred Drake 45540b0922 SF bug #1193966: Weakref types documentation misplaced
The information about supporting weakrefs with types defined in C extensions
is moved to the Extending & Embedding manual.  Py_TPFLAGS_HAVE_WEAKREFS is
no longer mentioned since it is part of Py_TPFLAGS_DEFAULT.
2006-07-29 20:04:42 +00:00
Andrew M. Kuchling 9964fdb466 [Patch #1068277] Clarify that os.path.exists() can return False depending on permissions. Fred approved committing this patch in December 2004! 2006-07-29 19:50:37 +00:00