Commit Graph

8067 Commits

Author SHA1 Message Date
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 9ad7a60f62 Repair typos 2006-07-27 18:44:10 +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
Andrew M. Kuchling 7a752e7ad4 Attribute more features 2006-07-17 16:47:54 +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
Fred Drake ec5948aae2 clean up some link markup 2006-07-16 01:21:20 +00:00
George Yoshida b2d5af8d9e Bug #15187702 : ext/win-cookbook.html has a broken link to distutils 2006-07-15 16:03:49 +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
Andrew M. Kuchling 8c051da2cf Mention new options 2006-07-14 13:32:38 +00:00
Neal Norwitz eda87127a8 Try to improve grammar further. 2006-07-14 07:20:04 +00:00
Georg Brandl 13b78d536b Patch #1521874: grammar errors in doanddont.tex. 2006-07-14 07:12:54 +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
Andrew M. Kuchling b0aa54ece8 Bump version number; add sys._current_frames 2006-07-11 17:20:16 +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
Anthony Baxter 70e8e87750 preparing for 2.5b2 2006-07-10 07:41:04 +00:00
Martin v. Löwis 8d65681e94 Introduce DISTUTILS_USE_SDK as a flag to determine whether the
SDK environment should be used. Fixes #1508010.
2006-07-10 07:23:48 +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
Thomas Heller 653f23cc81 Document the correct return type of PyLong_AsUnsignedLongLongMask. 2006-07-06 15:06:05 +00:00
Andrew M. Kuchling beb572b50a ImportWarning is now silent by default 2006-07-06 13:57:28 +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 94a98e4fc6 Update the tutorial section on relative imports 2006-07-06 13:04:56 +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
Andrew M. Kuchling cd77e1cb2d Describe workaround for PyRange_New()'s removal 2006-06-26 12:43:43 +00:00
Andrew M. Kuchling 1a0e129864 [Bug #1511998] Various comments from Nick Coghlan; thanks! 2006-06-26 12:40:02 +00:00
Andrew M. Kuchling 48a49f0c3b Fit Makefile for the Python doc environment better; this is a step toward
including the howtos in the build process.

	* Put LaTeX output in ../paper-<whatever>/.
	* Put HTML output in ../html/
	* Explain some of the Makefile variables
	* Remove some cruft dating to my environment (e.g. the 'web' target)

This makefile isn't currently invoked by the documentation build process,
so these changes won't destabilize anything.
2006-06-23 19:23:40 +00:00
Thomas Heller 978ec9a89f Small fixes, mostly in the markup. 2006-06-22 19:07:36 +00:00
Georg Brandl b2c9ba8c9d Fix my name ;) 2006-06-22 19:02:18 +00:00
Fred Drake 56b76c8a65 fix markup nit 2006-06-22 15:50:08 +00:00
Andrew M. Kuchling f6a84f5615 Mention how to suppress warnings 2006-06-22 13:10:23 +00:00
Neal Norwitz 418e73d89f Reset the doc date to today for the automatic doc builds 2006-06-22 06:35:30 +00:00
Andrew M. Kuchling 10340608f0 Bump version 2006-06-21 17:17:28 +00:00
Andrew M. Kuchling 643b041105 Note some of Barry's work 2006-06-21 17:17:10 +00:00
Andrew M. Kuchling b492244e35 Link to LibRef module documentation 2006-06-21 17:10:18 +00:00
Andrew M. Kuchling 1fb8d83a54 [Bug #1504456] Mention xml -> xmlcore change 2006-06-20 13:20:30 +00:00
Andrew M. Kuchling 7c4e79c9eb Minor edits and rearrangements; markup fix 2006-06-20 13:11:29 +00:00
Andrew M. Kuchling b1992d0ec6 Add introductory paragraphs summarizing the release; minor edits 2006-06-20 13:05:12 +00:00
Andrew M. Kuchling 5ab504ef2f Terminology and typography fixes 2006-06-20 12:19:54 +00:00
Andrew M. Kuchling 2c4e462e96 Add four library items 2006-06-20 12:15:09 +00:00
Andrew M. Kuchling f6856cef8e Uncomment wsgiref section 2006-06-20 11:52:16 +00:00
Fred Drake 7cea65cc27 remove non-working document formats from edist 2006-06-19 17:31:16 +00:00
Anthony Baxter d113680720 Preparing for 2.5b1. 2006-06-19 12:04:15 +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
Fred Drake f5da071ec8 remove unnecessary markup 2006-06-18 02:57:35 +00:00
George Yoshida 3f1f7bec74 Update url.
Old url returned status code:301 Moved permanently.
2006-06-17 16:39:13 +00:00
George Yoshida b8d2607692 markup fix 2006-06-17 16:31:52 +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
Georg Brandl 69f6168b76 Bug #805015: doc error in PyUnicode_FromEncodedObject. 2006-06-14 16:46:43 +00:00
Andrew M. Kuchling 7259d7bfd6 Add item 2006-06-14 13:59:15 +00:00
Thomas Heller f1435100cf Document paramflags. 2006-06-14 09:09:08 +00:00
Georg Brandl c54173c234 Bug #1153163: describe __add__ vs __radd__ behavior when adding
objects of same type/of subclasses of the other.
2006-06-14 08:31:39 +00:00
Thomas Heller bcae6222e5 Write more docs. 2006-06-14 07:08:38 +00:00
Georg Brandl 772beaafae Bug #1501122: mention __gt__ &co in description of comparison order. 2006-06-14 06:29:07 +00:00
Martin v. Löwis d825143be1 Patch #1455898: Incremental mode for "mbcs" codec. 2006-06-14 05:21:04 +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 M. Kuchling 317af10569 Add ability to set stack size 2006-06-13 16:41:41 +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
Andrew M. Kuchling aabc5f6f2f Mention uuid module 2006-06-13 11:57:04 +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
Fred Drake 9a7e4451d2 credit for SF patch #1303595 2006-06-10 20:02:58 +00:00
Fred Drake 5e30626f7f SF patch #1303595: improve description of __builtins__, explaining how it
varies between __main__ and other modules, and strongly suggest not touching
it but using __builtin__ if absolutely necessary
2006-06-10 20:01: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