Commit Graph

143 Commits

Author SHA1 Message Date
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
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
Nick Coghlan fee3dfc061 Update with statement documentation to use same terminology as 2.5a1 implementation 2006-04-23 15:39:16 +00:00
Georg Brandl e071b001ca bug #1462278: small fix in documentation of __op__ vs __rop__ methods 2006-04-01 07:23:08 +00:00
Georg Brandl 76a2caebed typos 2006-03-31 16:12:34 +00:00
Georg Brandl 4c974989d7 Add index entries for new-style/old-style class. 2006-03-31 15:12:16 +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 5d0f4c6193 Document the PEP 343 context manager protocol methods. 2006-03-27 19:59:34 +00:00
Guido van Rossum 38fff8c4e4 Checking in the code for PEP 357.
This was mostly written by Travis Oliphant.
I've inspected it all; Neal Norwitz and MvL have also looked at it
(in an earlier incarnation).
2006-03-07 18:50:55 +00:00
Armin Rigo ddddd2f7e6 Updating the short blob about old/new-style classes to reflect (IMHO) more
precisely the motivation and the differences.

Added links to www.python.org/doc/newstyle.html and a footnote to warn against
the statement "x[i] is equivalent to x.__getitem__(i)", which already caused
many invalid bug reports on SF.
2005-12-26 18:06:17 +00:00
Andrew M. Kuchling 6af5239501 Add placeholder section on old and new-style classes 2005-12-04 16:07:15 +00:00
Fred Drake 59c61911ac add missing "and" 2005-10-30 04:29:49 +00:00
Georg Brandl d430726b82 Better wording for integer ref entry. 2005-09-12 12:49:38 +00:00
Fred Drake b3dfc0ae5e - fix typo report by email, only 1.5 years late
- fix several consistency nits relating to \method{...()}
2005-09-07 04:57:56 +00:00
Georg Brandl 7da4edac28 Clarify what is meant with "whole numbers". 2005-09-04 18:30:19 +00:00
Georg Brandl 15ad935568 __new__ is a static method 2005-08-26 12:56:22 +00:00
Georg Brandl 8fc18a2010 bug [ 1261229 ] __new__ is class method 2005-08-25 21:56:45 +00:00
Raymond Hettinger a30616a88d SF bug #1249837: container methods raise KeyError not IndexError
Minor clarification.
2005-08-21 11:26:14 +00:00
Georg Brandl 1c330eb9eb Patch [ 1230615 ] Patch for (Doc) #1168746
Bug [ 1204734 ] incorrect description of __getattribute__
2005-07-02 10:27:31 +00:00
Raymond Hettinger f21569e53d Fix typo. 2005-04-26 05:18:53 +00:00
Greg Ward ff564d3391 SF #1156412: document the __new__() static method
(merge from release24-maint branch).
2005-03-08 01:10:20 +00:00
Raymond Hettinger 68804315e0 SF Patch #1093896: miscellaneous doc typos 2005-01-01 00:28:46 +00:00
Michael W. Hudson 5e897959db This is my patch
[ 1004703 ] Make func_name writable

plus fixing a couple of nits in the documentation changes spotted by MvL
and a Misc/NEWS entry.
2004-08-12 18:12:44 +00:00
Brett Cannon a031a0870d Add a missing space. 2004-06-29 04:14:02 +00:00
Fred Drake 67a521ef69 note that descriptor objects must be instances of new-style types
(closes SF bug #817742)
2004-05-06 12:44:29 +00:00
Fred Drake 7a700b873b clean up indexing for None, NotImplemented
closes SF bug #820344
2004-01-01 05:43:53 +00:00
Martin v. Löwis 95cf84a4f3 Patch #821093: Fix various typos. 2003-10-19 07:32:24 +00:00
Raymond Hettinger 92016dcc91 SF 810242. Fix doubled word errors. 2003-09-22 15:27:11 +00:00
Raymond Hettinger e41d4c8ec9 Added doubled word warnings. 2003-08-25 04:39:55 +00:00
Fred Drake a3788642a3 Fix representation of ^= operator in __ixor__() documentation.
Closes SF bug #776181.  Should be backported.
2003-07-23 15:18:03 +00:00
Raymond Hettinger 943277ecd3 Minor corrections. 2003-07-17 14:47:12 +00:00
Fred Drake ea690c4b25 - improve the description of how user-defined method
objects get made
  - improve the description of attribute retrieval from
    classes and class instances
  - add brief documentation of static method and
    class method objects.
2003-07-17 05:26:53 +00:00
Raymond Hettinger 4d6e8fe5d1 Clarify the lack of relationship between rich comparison operators.
Prompted by a discussion on comp.lang.python.
2003-07-16 19:40:23 +00:00
Fred Drake d51ce7de97 Indexing is a mess; try to get the link targets closer to the relevant
text.  There needs to be a better way.
2003-07-15 22:03:00 +00:00
Fred Drake e37b4ed24e Discuss calling new-style types.
Closes SF bug #453683.
2003-07-15 20:45:16 +00:00
Raymond Hettinger 5918f8de67 Minor fixes to punctuation and grammar. 2003-06-29 04:53:23 +00:00
Raymond Hettinger df9eff061e * Markup nits for the Invoking Descriptors section
* Documented __slots__
* Documented __metaclass__

Shamelessly plagarized from Guido's tutorial.
2003-06-27 06:57:56 +00:00
Fred Drake 4db3661e24 remove _ from label: LaTeX rejects this due to all the magic we use to
get the _ character to format like a normal character
2003-06-26 03:11:20 +00:00
Raymond Hettinger 03ec6d538a * Document how descriptors are invoked.
* Fix minor parenthesis matching errors in ref3.tex.
2003-06-25 18:29:36 +00:00
Brett Cannon 9e6fedd2ec Add explicit text for where an obindex call for generators was since obindex does not cause output of its argument. 2003-06-15 22:57:44 +00:00
Fred Drake 7af9f4dac3 Add a specific mention of the term "operator overloading" and add an
index entry.  Suggested to python-docs.
2003-05-12 13:50:11 +00:00
Fred Drake 62364ffb80 - apply SF patch #700798: fixes and cleanups for descriptor info
- use a TeX "tie" to prevent word-wrapping in "section x.y"-like text
2003-03-20 18:17:16 +00:00
Michael W. Hudson 2ab1d08f90 I thought it was common practice to check things compiled before
checking them in?  Oh well, this fixes various obvious mistakes and
changes a subsubsubsection (which doesn't exist) into a subsubsection
(which does).  I'm not sure this matches the intent, but it seems to
read OK on a quick skim.
2003-03-05 14:20:58 +00:00
Guido van Rossum d41eea05f4 SF doc patch #692001, properties and __getattribute__. I added some
stuff, and changed 'property' to 'descriptor'.
2003-02-28 14:11:45 +00:00
Jeremy Hylton f9b0cc7df6 Document __module__. 2003-01-31 18:52:45 +00:00
Raymond Hettinger f4ca5a2f45 Fix typo 2003-01-19 14:57:12 +00:00
Raymond Hettinger e701dcbabd SF patch #634866: Alex Martelli's corrections to the ref manual.
Backport candidate.  All but one or two of these changes
are applicable to 2.2.2.
2003-01-19 13:08:18 +00:00
Michael W. Hudson cfd3884882 This is Richie Hindle's patch
[ 643835 ] Set Next Statement for Python debuggers

with a few tweaks by me: adding an unsigned or two, mentioning that
not all jumps are allowed in the doc for pdb, adding a NEWS item and
a note to whatsnew, and AuCTeX doing something cosmetic to libpdb.tex.
2002-12-17 16:15:34 +00:00
Fred Drake 5ec22f2d7b Another try at clarifying what goes into and comes out of Unicode objects.
Document the indices() method of slice objects.
2002-09-24 21:09:13 +00:00
Raymond Hettinger a0e4d6ceaf Clarified that the footnote applies to versions 1.5 and after instead of
just version 1.5.  Closes SF bug 577793.
2002-09-08 21:10:54 +00:00