Andrew M. Kuchling
4094b3d08c
Minor rewording
2006-06-03 18:43:24 +00:00
Andrew M. Kuchling
27ca711d20
[Bug #1441864 ] Clarify description of 'data' argument
2006-06-03 18:41:28 +00:00
Andrew M. Kuchling
794c89b678
[Bug #1475554 ] Strengthen text to say 'must' instead of 'should'
2006-06-03 18:33:35 +00:00
Andrew M. Kuchling
29d530b3ef
[Bug #1472084 ] Fix description of do_tag
2006-06-03 18:09:41 +00:00
Tim Peters
d609b1a20e
pprint functions used to sort a dict (by key) if and only if
...
the output required more than one line. "Small" dicts got
displayed in seemingly random order (the hash-induced order
produced by dict.__repr__). None of this was documented.
Now pprint functions always sort dicts by key, and the docs
promise it.
This was proposed and agreed to during the PyCon 2006 core
sprint -- I just didn't have time for it before now.
2006-06-02 23:22:51 +00:00
Andrew M. Kuchling
622f144175
[Bug #1473048 ]
...
SimpleXMLRPCServer and DocXMLRPCServer don't look at
the path of the HTTP request at all; you can POST or
GET from / or /RPC2 or /blahblahblah with the same results.
Security scanners that look for /cgi-bin/phf will therefore report
lots of vulnerabilities.
Fix: add a .rpc_paths attribute to the SimpleXMLRPCServer class,
and report a 404 error if the path isn't on the allowed list.
Possibly-controversial aspect of this change: the default makes only
'/' and '/RPC2' legal. Maybe this will break people's applications
(though I doubt it). We could just set the default to an empty tuple,
which would exactly match the current behaviour.
2006-05-31 14:08:48 +00:00
Brett Cannon
14a0952a1f
Clarify wording on default values for strptime(); defaults are used when better
...
values cannot be inferred.
Closes bug #1496315 .
2006-05-31 02:19:54 +00:00
Georg Brandl
261e251df8
Patches #1497027 and #972322 : try HTTP digest auth first,
...
and watch out for handler name collisions.
2006-05-29 20:52:54 +00:00
Nick Coghlan
c649ec5b69
Apply modified version of Collin Winter's patch #1478788
...
Renames functional extension module to _functools and adds a Python
functools module so that utility functions like update_wrapper can be
added easily.
2006-05-29 12:43:05 +00:00
George Yoshida
f3c65de460
Patch #1080727 : add "encoding" parameter to doctest.DocFileSuite
...
Contributed by Bjorn Tillenius.
2006-05-28 16:39:09 +00:00
Thomas Heller
cc7570fd90
Write more docs.
2006-05-26 19:43:45 +00:00
Fredrik Lundh
9c0e9c089c
needspeed: rpartition documentation, tests, and a bug fixes.
...
feel free to add more tests and improve the documentation.
2006-05-26 18:24:15 +00:00
Thomas Heller
2d6c5a868a
Reordered, and wrote more docs.
2006-05-26 17:47:40 +00:00
Thomas Heller
69bfaab304
Write some docs.
2006-05-26 17:18:33 +00:00
Thomas Heller
ada638bf91
For now, I gave up with automatic conversion of reST to Python-latex,
...
so I'm writing this in latex now.
Skeleton for the ctypes reference.
2006-05-26 16:42:44 +00:00
Andrew M. Kuchling
a0fcf502df
Typo fixes
2006-05-26 12:01:44 +00:00
Georg Brandl
0c93ff6709
Clarify docs for str.partition().
2006-05-26 09:05:54 +00:00
Fredrik Lundh
06a69dd8ff
needforspeed: partition implementation, part two.
...
feel free to improve the documentation and the docstrings.
2006-05-26 08:54:28 +00:00
Georg Brandl
007a382a4d
Bug #1490688 : properly document %e, %f, %g format subtleties.
2006-05-18 07:20:05 +00:00
Georg Brandl
7b90e168f3
Bug #1462152 : file() now checks more thoroughly for invalid mode
...
strings and removes a possible "U" before passing the mode to the
C library function.
2006-05-18 07:01:27 +00:00
Georg Brandl
b89316fdbf
Patch #1180296 : improve locale string formatting functions
2006-05-17 15:51:16 +00:00
Georg Brandl
c01b6aeede
Remove misleading comment about type-class unification.
2006-05-17 14:06:07 +00:00
Tim Peters
1b38357094
Text files missing the SVN eol-style property.
2006-05-16 23:24:08 +00:00
George Yoshida
0c8d7b0f3f
Document ImportWarning
2006-05-16 18:26:10 +00:00
George Yoshida
2f6ce536ab
Mention that Exception is now a subclass of BaseException.
...
Remove a sentence that says that BaseException inherits from BaseException.
(I guess this is just a copy & paste mistake.)
2006-05-16 18:07:00 +00:00
Georg Brandl
8d3342b489
Patch #1435422 : zlib's compress and decompress objects now have a
...
copy() method.
2006-05-16 07:38:27 +00:00
George Yoshida
90df06e5e2
Add \exception markup
2006-05-13 06:53:31 +00:00
Gerhard Häring
2b161d9038
Integrated the rest of the pysqlite reference manual into the Python
...
documentation. Ready to be reviewed and improved upon.
2006-05-12 23:49:49 +00:00
George Yoshida
4917c34b26
Grammar fix
2006-05-11 15:53:27 +00:00
Martin v. Löwis
879768dd97
Change WindowsError to carry the Win32 error code in winerror,
...
and the DOS error code in errno. Revert changes where
WindowsError catch blocks unnecessarily special-case OSError.
2006-05-11 13:28:43 +00:00
Georg Brandl
dd0c312703
Fix two small errors in argument lists.
2006-05-10 20:09:23 +00:00
Georg Brandl
38c6a22f38
Patch #1484695 : Update the tarfile module to version 0.8. This fixes
...
a couple of issues, notably handling of long file names using the
GNU LONGNAME extension.
2006-05-10 16:26:03 +00:00
Georg Brandl
f8d9a97ba2
Bug #1484978 : curses.panel: clarify that Panel objects are destroyed on garbage collection.
2006-05-10 16:11:44 +00:00
Georg Brandl
b1582557aa
Bug #1485447 : subprocess: document that the "cwd" parameter isn't used to find the executable. Misc. other markup fixes.
2006-05-10 16:09:03 +00:00
Georg Brandl
e7d9539eba
Bug #1482988 : indicate more prominently that the Stats class is in the pstats module.
2006-05-10 15:59:06 +00:00
Andrew M. Kuchling
0901965134
Minor language edit
2006-05-07 17:14:53 +00:00
George Yoshida
ce5933f582
Use \versionchanged for the feature change
2006-05-06 14:16:51 +00:00
George Yoshida
d3d8ecda15
describe optional arguments for DocFileSuite
2006-05-06 13:09:45 +00:00
Nick Coghlan
d8accb32a5
Get rid of a couple more context object references, fix some markup and clarify what happens when a generator context function swallows an exception.
2006-05-03 13:17:49 +00:00
Nick Coghlan
afd5e63e24
Finish bringing SVN into line with latest version of PEP 343 by getting rid of all remaining references to context objects that I could find. Without a __context__() method context objects no longer exist. Also get test_with working again, and adopt a suggestion from Neal for decimal.Context.get_manager()
2006-05-03 13:02:47 +00:00
Martin v. Löwis
a3a13298b2
Correct some formulations, fix XXX comments.
2006-05-03 04:52:04 +00:00
Tim Peters
4511a713d5
Whitespace normalization.
2006-05-03 04:46:14 +00:00
Fred Drake
3053667d09
fix up whitespace in prompt strings
2006-05-03 02:29:39 +00:00
Fred Drake
5f1cca0a1d
one more place to avoid extra markup (how many will there be?)
2006-05-03 02:29:09 +00:00
Fred Drake
f25fa6ddb9
avoid ugly markup based on the unfortunate conversions of ">>" and "<<" to
...
guillemets; no need for magic here
2006-05-03 02:04:40 +00:00
Guido van Rossum
da5b701aee
Get rid of __context__, per the latest changes to PEP 343 and python-dev
...
discussion.
There are two places of documentation that still mention __context__:
Doc/lib/libstdtypes.tex -- I wasn't quite sure how to rewrite that without
spending a whole lot of time thinking about it; and whatsnew, which Andrew
usually likes to change himself.
2006-05-02 19:47:52 +00:00
Fred Drake
017e68c413
SF #1479988 : add methods to allow access to weakrefs for the
...
weakref.WeakKeyDictionary and weakref.WeakValueDictionary
2006-05-02 06:53:59 +00:00
Neal Norwitz
c4edb0ec81
SF #1479181 : split open() and file() from being aliases for each other.
2006-05-02 04:43:14 +00:00
Andrew M. Kuchling
4bbf66e852
Markup fixes
2006-05-01 17:06:54 +00:00
Andrew M. Kuchling
edbe657174
Markup fixes; add some XXX comments noting problems
2006-05-01 16:30:25 +00:00
Martin v. Löwis
5f4307491e
Add msilib documentation.
2006-05-01 16:12:44 +00:00
Gerhard Häring
82560ebb8d
Further integration of the documentation for the sqlite3 module. There's still
...
quite some content to move over from the pysqlite manual, but it's a start now.
2006-05-01 15:14:48 +00:00
Fred Drake
6550f03216
- minor clarification in section title
...
- markup adjustments
(there is clearly much to be done in this section)
2006-05-01 06:25:58 +00:00
Georg Brandl
3583cff5a9
Patch #1472854 : make the rlcompleter.Completer class usable on non-
...
UNIX platforms.
2006-04-30 18:14:54 +00:00
Georg Brandl
fa42bd7af4
Patch #1470846 : fix urllib2 ProxyBasicAuthHandler.
2006-04-30 07:06:11 +00:00
George Yoshida
5085fe2bcc
Use \versionchanged instead of \versionadded for new parameter support.
2006-04-30 03:49:56 +00:00
Gerhard Häring
eb2e1926ac
This is the start of documentation for the sqlite3 module. Please feel free to
...
find a better place for the link to it than alongside bsddb & friends.
2006-04-29 23:12:41 +00:00
George Yoshida
f674939a2b
grammar fix
2006-04-29 02:43:30 +00:00
George Yoshida
d77167286f
correct a dead link
2006-04-28 16:40:14 +00:00
Georg Brandl
677800723a
Bug #1475009 : clarify ntpath.join behavior with absolute components
2006-04-28 16:36:55 +00:00
Andrew M. Kuchling
efd3a09fad
Mention the xmlrpclib.Error base class, which is used in one of the examples
2006-04-27 12:42:54 +00:00
Andrew M. Kuchling
356f938f94
[Bug #1477140 ] Import Error base class
2006-04-27 12:38:35 +00:00
Andrew M. Kuchling
7acb7b40ba
[Bug #1477102 ] Add necessary import to example
...
This may be a useful style question for the docs -- should examples show
the necessary imports, or should it be assumed that the reader will
figure it out? In the What's New, I'm not consistent but usually opt
for omitting the imports.
2006-04-27 12:34:39 +00:00
Fred Drake
4b8ec63114
add missing word
2006-04-27 00:20:14 +00:00
Nick Coghlan
790c3c1377
Fix an error in the last contextlib.closing example
2006-04-26 11:50:04 +00:00
Fred Drake
2afbf96f53
markup fixes, cleanup
2006-04-26 05:15:41 +00:00
Thomas Wouters
34a70c6011
Fix markup glitch in unittest docs. Will backport.
2006-04-25 12:28:56 +00:00
Nick Coghlan
e708cf5d0f
Fix latex typo
2006-04-25 11:05:56 +00:00
Nick Coghlan
a7e820a408
Move the PEP 343 documentation and implementation closer to the
...
terminology in the alpha 1 documentation.
- "context manager" reverts to its alpha 1 definition
- the term "context specifier" goes away entirely
- contextlib.GeneratorContextManager is renamed GeneratorContext
There are still a number of changes relative to alpha 1:
- the expression in the with statement is explicitly called the
"context expression" in the language reference
- the terms 'with statement context', 'context object' or 'with
statement context' are used in several places instead of a bare
'context'. The aim of this is to avoid ambiguity in relation to the
runtime context set up when the block is executed, and the context
objects that already exist in various application domains (such as
decimal.Context)
- contextlib.contextmanager is renamed to contextfactory
This best reflects the nature of the function resulting from the
use of that decorator
- decimal.ContextManager is renamed to WithStatementContext
Simple dropping the 'Manager' part wasn't possible due to the
fact that decimal.Context already exists and means something
different. WithStatementContext is ugly but workable.
A technically unrelated change snuck into this commit:
contextlib.closing now avoids the overhead of creating a
generator, since it's trivial to implement that particular
context manager directly.
2006-04-25 10:56:51 +00:00
Neal Norwitz
327ea38cc4
Revert previous change, SKIP had a versionadded elsewhere
2006-04-25 05:49:42 +00:00
Neal Norwitz
85c767ac87
versionadded for SKIP
2006-04-25 05:04:35 +00:00
Tim Peters
711bf30b89
Patch #1475231 : add a new SKIP doctest option, thanks to
...
Edward Loper.
2006-04-25 03:31:36 +00:00
Nick Coghlan
877cf234c9
Change PEP 343 related documentation to use the term context specifier instead of context object
2006-04-24 04:17:02 +00:00
Tim Peters
8dc73d2dc6
Bug #1337990 : clarified that `doctest` does not support examples
...
requiring both expected output and an exception.
I'll backport to 2.4 next.
2006-04-24 02:03:16 +00:00
Skip Montanaro
9ab2f453ac
it's always helpful if the example works...
2006-04-23 19:30:50 +00:00
Skip Montanaro
56a3706fcd
minor tweak
2006-04-23 19:26:33 +00:00
Skip Montanaro
47767c3b17
first cut at trace module doc
2006-04-23 19:14:27 +00:00
Nick Coghlan
5ef9d9fdb9
Update contextlib documentation to use the same terminology as the module implementation
2006-04-23 15:14:37 +00:00
Nick Coghlan
84faa85775
Add a Context Types section to parallel the Iterator Types section (uses the same terminology as the 2.5a1 implementation)
2006-04-23 15:13:32 +00:00
Greg Ward
ab05edc0d1
Update optparse to Optik 1.5.1.
2006-04-23 03:47:58 +00:00
George Yoshida
51a23fe266
- add versionadded tag
...
- make arbitrary arguments come last
2006-04-22 15:27:14 +00:00
George Yoshida
3c134a2046
Typo fixes
2006-04-22 15:10:49 +00:00
Andrew M. Kuchling
1da4a94719
Add Gregory K. Johnson's revised version of mailbox.py (funded by
...
the 2005 Summer of Code).
The revision adds a number of new mailbox classes that support adding
and removing messages; these classes also support mailbox locking and
default to using email.Message instead of rfc822.Message.
The old mailbox classes are largely left alone for backward compatibility.
The exception is the Maildir class, which was present in the old module
and now inherits from the new classes. The Maildir class's interface
is pretty simple, though, so I think it'll be compatible with existing
code.
(The change to the NEWS file also adds a missing word to a different
news item, which unfortunately required rewrapping the line.)
2006-04-22 02:32:43 +00:00
Thomas Heller
9f7e58afa7
Documentation for ctypes.
...
I think that 'generic operating system services' is the best category.
Note that the Doc/lib/libctypes.latex file is generated from reST sources.
You are welcome to make typo fixes, and I'll try to keep the reST sources
in sync, but markup changes would be lost - they should be fixed in the tool
that creates the latex file.
The conversion script is external/ctypes/docs/manual/mkpydoc.py.
2006-04-21 18:29:17 +00:00
George Yoshida
cd84b92f08
Correct the grammar
2006-04-21 16:34:17 +00:00
George Yoshida
0d840285c7
Fix a markup.
...
This generated a ugly code, "P>".
2006-04-21 16:21:12 +00:00
Andrew M. Kuchling
ba67a8a202
Typo, grammar fixes. This file could use another proofreading pass.
2006-04-21 12:58:30 +00:00
Andrew M. Kuchling
84a7ee7e91
Typo fixes
2006-04-21 12:38:41 +00:00
Skip Montanaro
262fb9256b
Allow pstats.Stats creator to specify an alternate to stdout.
2006-04-21 02:31:07 +00:00
Skip Montanaro
94785ef142
Correct implementation and documentation of os.confstr. Add a simple test
...
case. I've yet to figure out how to provoke a None return I can test.
2006-04-20 01:29:48 +00:00
George Yoshida
e7670a329e
fix typo
2006-04-18 16:18:15 +00:00
Martin v. Löwis
bd30f52881
Patch #790710 : Add breakpoint command lists in pdb.
2006-04-17 17:08:37 +00:00
Andrew M. Kuchling
8ed29143fc
Typo fix
2006-04-14 20:32:36 +00:00
Andrew M. Kuchling
121c98cce1
Typo fixes
2006-04-14 12:42:09 +00:00
Andrew M. Kuchling
984bdd759e
Typo fix
2006-04-14 12:07:41 +00:00
Gregory P. Smith
3adc4aa2fb
raise the minimum supported BerkeleyDB version to 3.3 and add notes to
...
news about this and a couple other recent fixes.
2006-04-13 19:19:01 +00:00
Phillip J. Eby
678b8ecd08
Forgot to mark up a PEP reference
2006-04-11 01:15:28 +00:00
Phillip J. Eby
4703211080
Updated the warnings, linecache, inspect, traceback, site, and doctest modules
...
to work correctly with modules imported from zipfiles or via other PEP 302
__loader__ objects. Tests and doc updates are included.
2006-04-11 01:07:43 +00:00
Georg Brandl
729156e7de
Bug #1465619 : rot13 codec decodes to a Unicode string.
2006-04-06 11:25:33 +00:00
Georg Brandl
caf9539b2b
Bug #1465600 : note encoding issue in ZipFile.write().
2006-04-06 10:03:32 +00:00