Commit Graph

7853 Commits

Author SHA1 Message Date
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
Andrew M. Kuchling 0a7ed8c2d3 Edits, using the new term
'context specifier' in a few places
2006-04-24 14:30:47 +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
Andrew M. Kuchling d4c2177b78 Add two items 2006-04-23 21:51:10 +00:00
Andrew M. Kuchling edb575e758 Edits to the PEP 343 section 2006-04-23 21:01:04 +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 09b1bc39e7 Take 2 on mentioning the with statement, this time without inadvertently killing the Unicode examples 2006-04-23 16:35:19 +00:00
Nick Coghlan e0ea50bc3b Add a (very) brief mention of the with statement to the end of chapter 8 2006-04-23 16:05:04 +00:00
Nick Coghlan fee3dfc061 Update with statement documentation to use same terminology as 2.5a1 implementation 2006-04-23 15:39:16 +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
George Yoshida a1d3b1011e wrap SyntaxError with \exception{} 2006-04-23 09:27:10 +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
Neal Norwitz 8694a6db0e Add libctypes as a dep 2006-04-22 06:07:46 +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
Andrew M. Kuchling 3ccdb6ab36 Typo fixes 2006-04-22 01:51:41 +00:00
Phillip J. Eby a93ee47422 Guido wrote contextlib, not me, but thanks anyway. ;) 2006-04-21 21:53:37 +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 e78eeb1544 Add item 2006-04-21 13:26:42 +00:00
Andrew M. Kuchling fb08e73714 Add \label to make better HTML filenames 2006-04-21 13:08:02 +00:00
Andrew M. Kuchling 42c6e2f6b2 Add two items; typographical improvement for the 'with' statement; minor edits 2006-04-21 13:01:45 +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 3a7b58e9ad Add TODO item 2006-04-21 12:57:58 +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
Andrew M. Kuchling 3b675d299c Change a footnote to a parenthetical (in two senses) paragraph 2006-04-20 13:43:21 +00:00
Andrew M. Kuchling af015cfcbf Argh, make another markup fix 2006-04-20 13:39:40 +00:00
Andrew M. Kuchling 33432183d8 Markup fix 2006-04-20 13:38:36 +00:00
Andrew M. Kuchling 63fe9b5ae2 Add some items; add "New module" consistently; make contextlib.closing example more interesting and more correct (thanks Gustavo!); add a name 2006-04-20 13:36:06 +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
Andrew M. Kuchling 6719131129 Write datetime.strptime() item; show use of @contextmanager in defining __context__ methods; minor edits; add two names 2006-04-19 12:55:39 +00:00
George Yoshida e7670a329e fix typo 2006-04-18 16:18:15 +00:00
Andrew M. Kuchling 952f196ae7 Add item 2006-04-18 12:38:19 +00:00
Martin v. Löwis bd30f52881 Patch #790710: Add breakpoint command lists in pdb. 2006-04-17 17:08:37 +00:00
George Yoshida 297bf82920 fix long option markup 2006-04-17 15:44:59 +00:00
Andrew M. Kuchling 0d660c0236 Update status of document 2006-04-17 14:01:36 +00:00
Andrew M. Kuchling f7823a341c Remove translated code hidden inside a comment environment; latex2html gets confused and includes half of it anyway 2006-04-17 14:00:31 +00:00
Andrew M. Kuchling 45bb98e8b9 Add item 2006-04-16 19:53:27 +00:00
Andrew M. Kuchling de0a23f74c Describe contextlib module. (Done for today...) 2006-04-16 18:45:11 +00:00
Andrew M. Kuchling d058d0036a Write most of the 'writing context managers' section. I'd like comments on it,
but wait for a few hours before you read it; I'm still revising it
    and will be tackling contextlib next.
Untabify
2006-04-16 18:20:05 +00:00
Andrew M. Kuchling 29b3d08604 Add an item; better crediting; fix error in SQL example; minor edits 2006-04-14 20:35:17 +00:00
Andrew M. Kuchling 8ed29143fc Typo fix 2006-04-14 20:32:36 +00:00
Martin v. Löwis 82972e7f01 Patch #702933: Undocument PyObject_NEW, PyObject_NEW_VAR,
and PyObject_DEL.
2006-04-14 15:58:03 +00:00
Andrew M. Kuchling 121c98cce1 Typo fixes 2006-04-14 12:42:09 +00:00
Andrew M. Kuchling c7095843ae Add more items 2006-04-14 12:41:19 +00:00
Andrew M. Kuchling 984bdd759e Typo fix 2006-04-14 12:07:41 +00:00
Andrew M. Kuchling 75ba244c7b Add an item and a reminder 2006-04-14 10:29:55 +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
Andrew M. Kuchling 5d4cf5ecc1 Typo fix 2006-04-13 13:02:42 +00:00
Andrew M. Kuchling 3b4fb041df [Bug #1464571] Mention that generator's .gi_frame can now be None 2006-04-13 12:49:39 +00:00
Andrew M. Kuchling 6fc6976507 Add some items 2006-04-13 12:37:21 +00:00
Andrew M. Kuchling 0f1955daee Include more detail on Coverity results and add a link; minor edits 2006-04-13 12:09:08 +00:00
Andrew M. Kuchling 61434b6d51 Describe sys.subversion, Py_GetBuildInfo()
Add metadata example
2006-04-13 11:51:07 +00:00
Andrew M. Kuchling aa571c9a0a Add missing word 2006-04-13 11:40:29 +00:00
Georg Brandl 9d548374e4 Add two entries about how to actually clear a list. 2006-04-13 08:04:56 +00:00
Martin v. Löwis bb30011880 Stop claiming that Py_Finalize releases all memory.
Fixes part of #1445210.
2006-04-13 07:28:29 +00:00
Neal Norwitz 5f5a69ba9d Fix {} mismatch spotted by George Yoshida. 2006-04-13 03:41:04 +00:00
Andrew M. Kuchling b66871f1c0 Fix typography of Martin's name 2006-04-13 02:10:16 +00:00
Andrew M. Kuchling 28c5f1fa16 Write some ctypes examples 2006-04-13 02:04:42 +00:00
Andrew M. Kuchling 5f445bf3df Mention ASCII as default encoding; update TODO list; use PyCF_ONLY_AST by MvL's suggestion; typographical tidying of MvL's name 2006-04-12 18:54:00 +00:00
Andrew M. Kuchling 8872dbff99 Bump version number; rearrange introduction a bit 2006-04-12 18:52:09 +00:00
Andrew M. Kuchling 6a67e4ead4 Add PEP 243 section 2006-04-12 13:03:35 +00:00
Andrew M. Kuchling f7c6290ca4 Note C API incompatibilities 2006-04-12 12:27:50 +00:00
Andrew M. Kuchling 4e86195a99 Mention access to ASTs 2006-04-12 12:16:31 +00:00
Andrew M. Kuchling 075e0231f1 Complete the ElementTree section 2006-04-11 13:14:56 +00:00
Georg Brandl ce27a06d37 Typo fix. 2006-04-11 06:27:12 +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
Andrew M. Kuchling 16ed521dd7 Write part of ElementTree section 2006-04-10 22:28:11 +00:00
Andrew M. Kuchling d58baf8592 Give SQLite examples 2006-04-10 21:40:16 +00:00
Martin v. Löwis 0bc2ab9a20 Patch #837242: id() for large ptr should return a long. 2006-04-10 20:28:17 +00:00
Andrew M. Kuchling 6e3a66de91 Fix a few XXX markers 2006-04-07 12:46:06 +00:00
Andrew M. Kuchling a4d651fbc8 Fix unfinished paragraph; markup fix 2006-04-06 13:24:58 +00:00
Andrew M. Kuchling 4d8cd8957a Expand the PEP 353 section; various smaller changes 2006-04-06 13:03:04 +00:00
Georg Brandl 4dce8e4e69 Bug #1464658: make clear that PyList_GetItem doesn't take negative indices. 2006-04-06 12:45:51 +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
Fred Drake 8038163ee6 revert incomplete changes committed by accident 2006-04-06 00:18:28 +00:00
Fred Drake ca30e1d5ec update URL to reflect new website 2006-04-06 00:17:08 +00:00
Andrew M. Kuchling 2cdb23ee5a Bump version number after alpha1 release 2006-04-05 13:59:01 +00:00
Andrew M. Kuchling d96a6ac544 Reference PEP 356 2006-04-04 19:17:34 +00:00
Andrew M. Kuchling c3749a9791 Add a paragraph about PEP 353; add a few more fixes 2006-04-04 19:14:41 +00:00
Andrew M. Kuchling 9c67ee08d8 Tidy up the document in preparation for 2.5alpha1. Hope I didn't break the markup... 2006-04-04 19:07:27 +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
Matthias Klose 8e39ec78bc - Patch #360466: Replace the MD5 implementation from RSA Data Security Inc
with the implementation from http://sourceforge.net/projects/libmd5-rfc/.
2006-04-03 16:27:50 +00:00
Anthony Baxter ebed3f629b preparation for 2.5a1 2006-04-03 15:03:44 +00:00
Andrew M. Kuchling af7ee99a49 Add sections for new modules; will write tutorial later 2006-04-03 12:41:37 +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
Fredrik Lundh 31fe35bdee end the sentence... 2006-04-02 07:59:55 +00:00
Fred Drake 1c0e3284f9 fix markup error 2006-04-02 03:30:06 +00:00
Andrew M. Kuchling e8058299a5 Grammar fix 2006-04-02 01:47:38 +00:00
Andrew M. Kuchling 38f85078da Write various sections; I haven't been able to check whether the TeX markup is correct 2006-04-02 01:46:32 +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
Andrew M. Kuchling f2d712b265 Update status of this PEP 2006-04-01 10:32:13 +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
Georg Brandl e071b001ca bug #1462278: small fix in documentation of __op__ vs __rop__ methods 2006-04-01 07:23: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
Martin v. Löwis 22f3a6ae1c Add 2.5 libraries. 2006-03-31 16:19:18 +00:00
Georg Brandl 76a2caebed typos 2006-03-31 16:12:34 +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 4c974989d7 Add index entries for new-style/old-style class. 2006-03-31 15:12:16 +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 c44e14eba0 Fix typos. 2006-03-31 11:03:57 +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 7b8cf38927 improve reporting of illegal section nesting (provide location which
caused detection of the error)
2006-03-31 05:30:19 +00:00
Fred Drake 842ab70ecf fix sectioning: cannot skip section levels 2006-03-31 05:28:38 +00:00
Barry Warsaw 176014ffad SF patch #1458476 with modifications based on discussions in python-dev. This
adds the following API calls: PySet_Clear(), _PySet_Next(), and
_PySet_Update().  The latter two are considered non-public.  Tests and
documentation (for the public API) are included.
2006-03-30 22:45:35 +00:00
Phillip J. Eby 80a5d01790 Mark the upload command as new in 2.5, per Neal Norwitz's request. 2006-03-30 07:09:06 +00:00
Fred Drake 66bc4efef3 fill in refcount information for APIs first documented in Python 2.5 2006-03-30 03:04:41 +00:00
Fred Drake 3e482d9a95 merge revision 43437 from the release24-maint branch:
- update the refcount information (late, but not a bad thing to do...)
- clarify that PyGen_New() steals a reference
2006-03-30 02:58:38 +00:00
Phillip J. Eby 2e550b3dd2 Implementation for patch request #1457316: support --identity option
for setup.py "upload" command.
2006-03-30 02:12:14 +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
Georg Brandl b6e92c40a9 Document change made to number of preallocated integers. 2006-03-27 22:09:16 +00:00
Phillip J. Eby 16e86da730 The "with" statement needs a __future__. :) 2006-03-27 21:42:30 +00:00
Phillip J. Eby 075ef1ac1b Document the "with" statement. 2006-03-27 21:06:13 +00:00
Phillip J. Eby 5d0f4c6193 Document the PEP 343 context manager protocol methods. 2006-03-27 19:59:34 +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
Phillip J. Eby 1a9fac0937 Yield is now allowed in try-finally, so update docs accordingly 2006-03-25 00:46:43 +00:00