Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
36,660 Commits 6 Branches 592 Tags 2.4 GiB
Commit Graph

4339 Commits

Author SHA1 Message Date
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
Andrew M. Kuchling 956597f4ef Reorganize the docs for 'file' and 'open()' after some discussion with Fred. 
We want to encourage users to write open() when opening a file, but
open() was described with a single paragraph and
'file' had lots of explanation of the mode and bufsize arguments.

I've shrunk the description of 'file' to cross-reference to the 'File
objects' section, and to open() for an explanation of the arguments.

open() now has all the paragraphs about the mode string.  The bufsize
argument was moved up so that it isn't buried at the end; now there's
1 paragraph on mode, 1 on bufsize, and then 3 more on mode.  Various
other edits and rearrangements were made in the process.

It's probably best to read the final text and not to try to make sense
of the diffs.
 2006-07-29 18:14:07 +00:00
Fred Drake fbdeaad069 expunge the xmlcore changes: 
41667, 41668 - initial switch to xmlcore
  47044        - mention of xmlcore in What's New
  50687        - mention of xmlcore in the library reference

re-apply xmlcore changes to xml:
  41674        - line ending changes (re-applied manually), directory props
  41677        - add cElementTree wrapper
  41678        - PSF licensing for etree
  41812        - whitespace normalization
  42724        - fix svn:eol-style settings
  43681, 43682 - remove Python version-compatibility cruft from minidom
  46773        - fix encoding of \r\n\t in attr values in saxutils
  47269        - added XMLParser alias for cElementTree compatibility

additional tests were added in Lib/test/test_sax.py that failed with
the xmlcore changes; these relate to SF bugs #1511497, #1513611
 2006-07-29 16:56:15 +00:00
Andrew M. Kuchling e49741d412 [Bug #1528258] Mention that the 'data' argument can be None. 
The constructor docs referred the reader to the add_data() method's docs,
but they weren't very helpful.  I've simply copied an earlier explanation
of 'data' that's more useful.
 2006-07-29 15:57:08 +00:00
Matt Fleming aab30d0f08 Fix typo 2006-07-29 15:55:30 +00:00
Andrew M. Kuchling b9d7e04880 [Bug #1530382] Document SSL.server(), .issuer() methods 2006-07-29 15:35:21 +00:00
Andrew M. Kuchling 7092f4ce9f [Bug #1519571] Document some missing functions: setup(), title(), done() 2006-07-29 14:42:48 +00:00
Andrew M. Kuchling dafb1e59c9 [Bug #1529157] Mention raw_input() and input(); while I'm at it, reword the description a bit 2006-07-29 14:21:15 +00:00
Andrew M. Kuchling 3ec3f78c8a Reword paragraph to match the order of the subsequent sections 2006-07-29 14:08:15 +00:00
Andrew M. Kuchling 144691cfd8 Update URL 2006-07-29 14:04:47 +00:00
Andrew M. Kuchling 35f64c12d3 Add example 2006-07-29 13:56:48 +00:00
Georg Brandl 9fd21e31b6 Bug #835255: The "closure" argument to new.function() is now documented. 2006-07-29 08:51:21 +00:00
Phillip J. Eby f7575d0cb7 Bug #1529871: The speed enhancement patch #921466 broke Python's compliance 
with PEP 302.  This was fixed by adding an ``imp.NullImporter`` type that is
used in ``sys.path_importer_cache`` to cache non-directory paths and avoid
excessive filesystem operations during imports.
 2006-07-28 21:12:07 +00:00
Andrew M. Kuchling 39d7739e6c Add example. Should I propagate this example to all the other DBM-ish modules, too? 2006-07-28 12:48:07 +00:00
Andrew M. Kuchling 1d69a7013f Don't overwrite built-in name; add some blank lines for readability 2006-07-28 12:45:55 +00:00
Andrew M. Kuchling bd468103e0 Add example 2006-07-28 12:33:19 +00:00
Andrew M. Kuchling 4036f43cac Add example 2006-07-28 12:32:43 +00:00
Andrew M. Kuchling 984b075978 Typo fix 2006-07-28 12:18:22 +00:00
Tim Peters 750c4420a8 Live with that "the hardware address" is an ill-defined 
concept, and that different ways of trying to find "the
hardware address" may return different results.  Certainly
true on both of my Windows boxes, and in different ways
(see whining on python-dev).
 2006-07-28 04:51:59 +00:00
Barry Warsaw 00decd7835 Patch #1520294: Support for getset and member descriptors in types.py, 
inspect.py, and pydoc.py.  Specifically, this allows for querying the type of
an object against these built-in C types and more importantly, for getting
their docstrings printed in the interactive interpreter's help() function.

This patch includes a new built-in module called _types which provides
definitions of getset and member descriptors for use by the types.py module.
These types are exposed as types.GetSetDescriptorType and
types.MemberDescriptorType.  Query functions are provided as
inspect.isgetsetdescriptor() and inspect.ismemberdescriptor().  The
implementations of these are robust enough to work with Python implementations
other than CPython, which may not have these fundamental types.

The patch also includes documentation and test suite updates.

I commit these changes now under these guiding principles:

1. Silence is assent.  The release manager has not said "no", and of the few
   people that cared enough to respond to the thread, the worst vote was "0".

2. It's easier to ask for forgiveness than permission.

3. It's so dang easy to revert stuff in svn, that you could view this as a
   forcing function. :)

Windows build patches will follow.
 2006-07-27 23:43:15 +00:00
Andrew M. Kuchling fc0e61d9b6 Add example 2006-07-27 22:49:54 +00:00
Andrew M. Kuchling 752e28ad9f Add example 2006-07-27 22:49:38 +00:00
Andrew M. Kuchling 4b6d53780d Reword paragraph 2006-07-27 22:40:05 +00:00
Andrew M. Kuchling cff784caa7 If binhex is higher-level than binascii, it should come first in the chapter 2006-07-27 19:12:49 +00:00
Andrew M. Kuchling 40b35aa5cc Mention base64 module; rewrite last sentence to be more positive 2006-07-27 19:11:07 +00:00
Andrew M. Kuchling cbe801697b Add punctuation mark; add some examples 2006-07-27 19:07:29 +00:00
Andrew M. Kuchling f60eeb1738 Update URL; add example 2006-07-27 18:53:33 +00:00
Andrew M. Kuchling 623005e94a Add missing word 2006-07-27 18:42:41 +00:00
Andrew M. Kuchling 5ee6616528 Typo fix ('publically' is rare, poss. non-standard) 2006-07-27 18:41:21 +00:00
Andrew M. Kuchling 9dd8dc3fee Add example 2006-07-27 18:37:33 +00:00
Greg Ward 48fae7acd2 Resync optparse with Optik 1.5.3: minor tweaks for/to tests. 2006-07-23 16:05:51 +00:00
Barry Warsaw b110bad2d9 More RFC 2231 improvements for the email 4.0 package. As Mark Sapiro rightly 
points out there are really two types of continued headers defined in this
RFC (i.e. "encoded" parameters with the form "name*0*=" and unencoded
parameters with the form "name*0="), but we were were handling them both the
same way and that isn't correct.

This patch should be much more RFC compliant in that only encoded params are
%-decoded and the charset/language information is only extract if there are
any encoded params in the segments.  If there are no encoded params then the
RFC says that there will be no charset/language parts.

Note however that this will change the return value for Message.get_param() in
some cases.  For example, whereas before if you had all unencoded param
continuations you would have still gotten a 3-tuple back from this method
(with charset and language == None), you will now get just a string.  I don't
believe this is a backward incompatible change though because the
documentation for this method already indicates that either return value is
possible and that you must do an isinstance(val, tuple) check to discriminate
between the two.  (Yeah that API kind of sucks but we can't change /that/
without breaking code.)

Test cases, some documentation updates, and a NEWS item accompany this patch.
 2006-07-21 14:51:07 +00:00
Fred Drake 3fda93604c markup fix 2006-07-20 20:11:57 +00:00
Vinay Sajip 9325ba6df4 Updated documentation for TimedRotatingFileHandler relating to how rollover files are named. The previous documentation was wrongly the same as for RotatingFileHandler. 2006-07-20 16:28:39 +00:00
Brett Cannon caebe22038 Fix bug #1520914. Starting in 2.4, time.strftime() began to check the bounds 
of values in the time tuple passed in.  Unfortunately people came to rely on
undocumented behaviour of setting unneeded values to 0, regardless of if it was
within the valid range.  Now those values force the value internally to the
minimum value when 0 is passed in.
 2006-07-18 04:41:36 +00:00
Fred Drake 83fa22f564 document xmlcore (still minimal; needs mention in each of the xml.* modules) 
SF bug #1504456 (partial)
 2006-07-17 05:47:52 +00:00
Fredrik Lundh 76e268bb62 typo 2006-07-14 21:45:48 +00:00
Thomas Heller b69a3c2bda Updates for the ctypes documentation. 2006-07-14 18:22:50 +00:00
Peter Astrand 7d1d43630e Bug #1223937: CalledProcessError.errno -> CalledProcessError.returncode. 2006-07-14 14:04:45 +00:00
Thomas Heller 76c5af6216 Fix the wrong description of LibraryLoader.LoadLibrary, and document 
the DEFAULT_MODE constant.
 2006-07-12 14:25:18 +00:00
Martin v. Löwis 06c68b800c Patch #1519566: Remove unused _tofill member. 
Make begin_fill idempotent.
Update demo2 to demonstrate filling of concave shapes.
 2006-07-10 22:11:28 +00:00
Tim Peters 32a8361f2d After approval from Anthony, merge the tim-current_frames 
branch into the trunk.  This adds a new sys._current_frames()
function, which returns a dict mapping thread id to topmost
thread stack frame.
 2006-07-10 21:08:24 +00:00
Neal Norwitz 56640df6c3 Patch #1504046: Add documentation for xml.etree. 
/F wrote the text docs, Englebert Gruber massaged it to latex and I
did some more massaging to try and improve the consistency and
fix some name mismatches between the declaration and text.
 2006-07-10 02:36:41 +00:00
Georg Brandl b6b175229b Fix RFC number. 2006-07-07 08:15:12 +00:00
Nick Coghlan 2bfe3a9dbf Cover ImportWarning, PendingDeprecationWarning and simplefilter() in the warnings module docs 2006-07-06 13:41:34 +00:00
Nick Coghlan 56829d5b4a Revert the __module_name__ changes made in rev 47142. We'll revisit this in Python 2.6 2006-07-06 12:53:04 +00:00
Thomas Heller b979b35f70 Document the changes in svn revision 47263, from patch #1517790. 2006-07-06 09:11:22 +00:00
Thomas Heller f40aed930a Document the Struture and Union constructors. 2006-07-06 08:58:40 +00:00
Georg Brandl d41f4ce0c8 no need to elaborate "string". 2006-07-05 15:50:05 +00:00
Georg Brandl f41beacecb Patch #1517490: fix glitches in filter() docs. 2006-07-05 14:18:45 +00:00
Andrew M. Kuchling 2eda1b78f9 [Bug #1511911] Clarify description of optional arguments to sorted() 
by improving the xref to the section on lists, and by
   copying the explanations of the arguments (with a slight modification).
 2006-07-03 14:16:09 +00:00
Andrew M. Kuchling f896795103 [Bug #1515932] Clarify description of slice assignment 2006-07-03 14:07:30 +00:00
Martin v. Löwis 82c276ea33 Document functions added in 2.3 and 2.5. 2006-07-03 11:12:06 +00:00
Fred Drake 6f42dfce7c - consistency nit: always include "()" in \function and \method 
(*should* be done by the presentation, but that requires changes all over)
- avoid spreading the __name meme
 2006-06-30 19:29:25 +00:00
Georg Brandl 348b7c8304 Document decorator usage of property. 2006-06-30 18:47:56 +00:00
Skip Montanaro 4ef256cab0 add string methods to index 2006-06-29 19:20:09 +00:00
Andrew M. Kuchling ecfec78b7b [Bug #1508766] Add docs for uuid module; this puts the module in the 'Internet Protocols' section. Arguably this module could also have gone in the chapters on strings or encodings, maybe even the crypto chapter. Fred, please move if you see fit. 2006-06-28 14:27:21 +00:00
Andrew M. Kuchling 146d3924b0 [Bug #1508766] Add docs for uuid module; docs written by George Yoshida, with minor rearrangements by me. 2006-06-28 14:25:20 +00:00
Nick Coghlan 999a336ad7 Make full module name available as __module_name__ even when __name__ is set to something else (like '__main__') 2006-06-28 10:41:47 +00:00
Thomas Heller 978ec9a89f Small fixes, mostly in the markup. 2006-06-22 19:07:36 +00:00
Thomas Heller 066769c307 Fix typos. 
Fix doctest example.
Mention in the tutorial that 'errcheck' is explained in the ref manual.
Use better wording in some places.
Remoce code examples that shouldn't be in the tutorial.
Remove some XXX notices.
 2006-06-18 21:27:04 +00:00
George Yoshida 3f1f7bec74 Update url. 
Old url returned status code:301 Moved permanently.
 2006-06-17 16:39:13 +00:00
Fred Drake fab461a4b5 SF patch 1504676: Make sgmllib char and entity references pluggable 
(implementation/tests contributed by Sam Ruby)
 2006-06-16 23:45:06 +00:00
Gregory P. Smith b526a29dbc minor documentation cleanup. mention the bsddb.db interface explicitly by name. 2006-06-15 09:23:52 +00:00
Ronald Oussoren 143cefb846 Patch #1446489 (zipfile: support for ZIP64) 2006-06-15 08:14:18 +00:00
Thomas Heller f1435100cf Document paramflags. 2006-06-14 09:09:08 +00:00
Thomas Heller bcae6222e5 Write more docs. 2006-06-14 07:08:38 +00:00
Tim Peters 43898b4f64 SequenceMatcher.get_matching_blocks(): This now guarantees that 
adjacent triples in the result list describe non-adjacent matching
blocks.  That's _nice_ to have, and Guido said he wanted it.

Not a bugfix candidate:  Guido or not ;-), this changes visible
endcase semantics (note that some tests had to change), and
nothing about this was documented before.  Since it was working
as designed, and behavior was consistent with the docs, it wasn't
"a bug".
 2006-06-14 04:09:25 +00:00
Gerhard Häring 5d7c290b7b Updated documentation for pysqlite 2.3.0 API. 2006-06-13 22:53:48 +00:00
Thomas Heller b66902fc90 More docs for ctypes. 2006-06-13 20:18:43 +00:00
Andrew MacIntyre 9291332de1 Patch #1454481: Make thread stack size runtime tunable. 
Heavily revised, comprising revisions:
46640 - original trunk revision (backed out in r46655)
46647 - markup fix (backed out in r46655)
46692:46918 merged from branch aimacintyre-sf1454481

branch tested on buildbots (Windows buildbots had problems
not related to these changes).
 2006-06-13 15:04:24 +00:00
Nick Coghlan f0d02fbb9a The site module documentation also described the Windows behaviour incorrectly. 2006-06-12 08:27:13 +00:00
Greg Ward d1c797e624 SF #1366250: optparse docs: fix inconsistency in variable name; minor tweaks. 2006-06-11 14:42:41 +00:00
Neal Norwitz a754a229b4 Add versionadded to doc 2006-06-11 05:45:47 +00:00
Greg Ward 7f54740c4d Bug #1361643: fix textwrap.dedent() so it handles tabs appropriately, 
i.e. do *not* expand tabs, but treat them as whitespace that is not
equivalent to spaces.  Add a couple of test cases.  Clarify docs.
 2006-06-11 00:40:49 +00:00
Thomas Heller 82578c895c New docs for ctypes. 2006-06-10 20:29:34 +00:00
Greg Ward c5221e157e Sync with Optik docs (rev 518): 
* restore "Extending optparse" section
  * document ALWAYS_TYPED_ACTIONS (SF #1449311)
 2006-06-10 16:40:01 +00:00
Georg Brandl 242508160e RFE #1491485: str/unicode.endswith()/startswith() now accept a tuple as first argument. 2006-06-09 18:45:48 +00:00
Phillip J. Eby 5cf565ddd1 Import wsgiref into the stdlib, as of the external version 0.1-r2181. 2006-06-09 16:40:18 +00:00
Nick Coghlan 676725db92 Add functools.update_wrapper() and functools.wraps() as described in PEP 356 2006-06-08 13:54:49 +00:00
Andrew M. Kuchling 06c5c8a4d3 Typo fix 2006-06-08 11:56:44 +00:00
Andrew M. Kuchling e275d3d4ce Mention other placeholders 2006-06-07 17:04:01 +00:00
Andrew M. Kuchling 12238d72a8 Add an SQLite introduction, taken from the 'What's New' text 2006-06-07 13:55:33 +00:00
Tim Peters dba6318ae6 On python-dev Thomas Heller said these were committed 
by mistake in rev 46693, so reverting this part of
rev 46693.
 2006-06-06 15:52:35 +00:00
Thomas Heller 56dab85022 Specify argtypes for all test functions. Maybe that helps on strange ;-) architectures 2006-06-06 15:34:18 +00:00
Tim Peters bf0400abe9 Remove doctest.testmod's deprecated (in 2.4) `isprivate` 
argument.  A lot of hair went into supporting that!
 2006-06-05 01:43:03 +00:00
Tim Peters 28eeefe566 Revert revisions: 
46640 Patch #1454481:  Make thread stack size runtime tunable.
46647 Markup fix

The first is causing many buildbots to fail test runs, and there
are multiple causes with seemingly no immediate prospects for
repairing them.  See python-dev discussion.

Note that a branch can (and should) be created for resolving these
problems, like

svn copy svn+ssh://svn.python.org/python/trunk -r46640 svn+ssh://svn.python.org/python/branches/NEW_BRANCH

followed by merging rev 46647 to the new branch.
 2006-06-04 23:52:47 +00:00
George Yoshida 67966bed72 Markup fix 2006-06-04 17:17:25 +00:00
Andrew MacIntyre 6539d2d3c7 Patch #1454481: Make thread stack size runtime tunable. 2006-06-04 12:31:09 +00:00
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&gt;".
 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
Walter Dörwald f7bc5f9455 Change the example classes UnicodeReader and UnicodeWriter so 
that they work with all encodings. For UnicodeReader the real
input stream is wrapped in a line iterator that reencodes the
input to UTF-8. For UnicodeWriter the UTF-8 encoded output is
written to a queue for where it is reencoded to the target
encoding and written to the real output stream.
 2006-04-04 17:32:49 +00:00
David Goodger cb30f97bd3 added another example of Unicode CSV parsing; reworked the example text a bit; corrected notice in the intro and added a link to the examples 2006-04-04 03:05:44 +00:00
Neal Norwitz 92e212f7d9 Accept keyword arguments for __import__ and doc the addition of the level param from PEP 328. 2006-04-03 04:48:37 +00:00
Georg Brandl 5f284da2d4 Document recent fdopen() change. 2006-04-02 21:18:27 +00:00
Andrew M. Kuchling e8058299a5 Grammar fix 2006-04-02 01:47:38 +00:00
Fred Drake ad5177cf8d Patch #624325: urlparse.urlparse() and urlparse.urlsplit() results 
now sport attributes that provide access to the parts of the result.
 2006-04-01 22:14:43 +00:00
Walter Dörwald f878b8120c Make firstweekday a simple attribute instead 
of hiding it behind a setter and a getter.
 2006-04-01 20:40:23 +00:00
Georg Brandl cd10347b65 Fix LaTeX oversight. 2006-04-01 20:40:16 +00:00
Georg Brandl 9cdf56318d clarify new docs on attr value entity expansion 2006-04-01 08:39:50 +00:00
Georg Brandl 7f6b67c235 patch #1462498: handle entityrefs in attribute values. 2006-04-01 08:35:18 +00:00
Walter Dörwald 48d5e508eb Bug #947906: Add classes LocaleTextCalendar and LocaleHTMLCalendar, 
that output localized month and weekday names and can cope
with encodings.
 2006-04-01 07:57:00 +00:00
Georg Brandl 014d29f331 Patch #1462496: typo in libsignal.tex 2006-04-01 07:42:41 +00:00
Georg Brandl 22a9dc889d Patch #1459631: documnent zlib.Decompress.flush() length parameter. 2006-04-01 07:39:41 +00:00
Georg Brandl dcfdae7d72 Bug #1460564: document that socket.fromfd() duplicates the given 
file descriptor.
 2006-04-01 07:33:08 +00:00
Fred Drake 23fd3d49e9 add support for the sips: scheme (identical to sip: except for scheme name) 2006-04-01 06:11:07 +00:00
Georg Brandl b88e19c1fc bug #1444104: add note about fdopen() to os.open(). 2006-03-31 19:20:13 +00:00
Georg Brandl 338ef7d2bd Bug #1445068: getpass.getpass() can now be given an explicit stream 
argument to specify where to write the prompt.
 2006-03-31 18:42:16 +00:00
Georg Brandl 3bf538f13d Complete markup. 2006-03-31 15:38:44 +00:00
Walter Dörwald 58917a6083 Bug #947906: An object oriented interface has been added to the calendar 
module. It's possible to generate HTML calendar now and the module can be
called as a script (e.g. via ``python -mcalendar``).
 2006-03-31 15:26:22 +00:00
Georg Brandl b227bea292 object() is a function, not a base class. 2006-03-31 15:07:25 +00:00
Georg Brandl 1320cf8e61 Bug #1461610: xmlrpclib has no function "binary". 2006-03-31 14:35:10 +00:00
Walter Dörwald a35b05ebd0 Clarify what the final argument does in 
IncrementalDecoder.decode().
 2006-03-31 09:15:29 +00:00
Fred Drake 842ab70ecf fix sectioning: cannot skip section levels 2006-03-31 05:28:38 +00:00
Georg Brandl 275935db8d document sys.maxint in std objects 2006-03-28 18:02:44 +00:00
Georg Brandl 7fd548f9c1 Bug #1459103: add inter-section links for strftime section. 2006-03-28 12:48:43 +00:00
Neal Norwitz d03b073e9b Add version added info for with statement and context managers 2006-03-28 05:51:02 +00:00
Phillip J. Eby 168e99f6db Document objects that can be used with the ``with`` statement. 2006-03-28 00:13:10 +00:00
Phillip J. Eby bdfd693804 Fix some missing imports 2006-03-28 00:08:22 +00:00
Phillip J. Eby d207b4f376 Document the contextlib module. 2006-03-27 23:58:46 +00:00
Raymond Hettinger a531e5b84c Guarantee evaluation order for izip(). Document its creative uses and its limitations. 2006-03-26 01:41:25 +00:00
Raymond Hettinger 4d65af0807 Add section headers and examples. 2006-03-25 23:26:43 +00:00
Neal Norwitz 6a91e94e66 SF bug # 1457358 and patch # 1458419, floor division not documented. Patch by Andy. 
Will backport.
 2006-03-25 21:25:30 +00:00
Raymond Hettinger fd3fcf0b35 SF Patch #1455676: Simplify using Queues with daemon consumer threads 
Adds join() and task_done() methods to track when all enqueued tasks have
been gotten and fully processed by daemon consumer threads.
 2006-03-24 20:43:29 +00:00
Nick Coghlan 98bcb70815 Add documentation for PEP 338 2006-03-24 13:36:33 +00:00
Georg Brandl bb03ac0dae Correct API design mistake from rev. 43126: make socket attributes readonly properties. 2006-03-21 18:17:25 +00:00
Georg Brandl 48b4bf7b1a Add a note about pow(x,y) equalling x**y (the "**" operator 
was used unmotivated in the pow() docs)
 2006-03-21 08:48:04 +00:00
Neal Norwitz 05a45599d7 Patch #1309579: wait3 and wait4 were added to the posix module by Chad J. Schroeder. 
This was a fair amount of rework of the patch.  Refactored test_fork1 so it
could be reused by the new tests for wait3/4.  Also made them into new style
unittests (derive from unittest.TestCase).
 2006-03-20 06:30:08 +00:00
Anthony Baxter fa86907aae SF [ 1231053 ] audioop - alaw encoding/decoding added, code updated 
This patch adds a-LAW encoding to audioop and replaces the old
u-LAW encoding/decoding code with the current code from sox.

Possible issues: the code from sox uses int16_t.

Code by Lars Immisch
 2006-03-20 05:21:58 +00:00