Commit Graph

4645 Commits

Author SHA1 Message Date
Fred Drake ecd8157a2c Include a warning that scripts should not have the same name as standard
modules, or the module cannot be properly imported.  (Based on a suggestion
sent to python-docs.)

Update the displayed dir() of the sys and __builtin__ module with Python 2.2.
2001-12-04 19:47:46 +00:00
Fred Drake 6016dbecca Talk about str() in the discussion of string representations of values, and
give examples for which str() and repr() yield different results.
This closes SF bug #485446.
2001-12-04 19:20:43 +00:00
Fred Drake bb7775a6ae Fix SF bug #479967: Appearantly I broke something that made the index
insertion work.  This fix makes things at least somewhat more explicit, and
adds a little sanity checking (and verbosity!) to
add_bbl_and_idx_dummy_commands().
2001-12-04 17:03:54 +00:00
Fred Drake 97e3201220 Add a note that the rgbimg module is only built on 32-bit machines (prompted
by a question to webmaster).
Re-wrapped a long line.
2001-12-04 16:49:00 +00:00
Fred Drake b48b6d0737 Remove meaningless comment. 2001-12-04 16:32:04 +00:00
Jeremy Hylton db5a93cd6a Update docs to reflect new compile() and compileFile() 2001-12-04 02:48:52 +00:00
Fred Drake b38784e4a0 Slightly improved indexing for the string-% operator, thanks to comments
from Skip Montanaro.  There is one weirdness in the final index for HTML, but
that is low priority.
2001-12-03 22:15:56 +00:00
Fred Drake fcf94681ed Update lambda description to reflect nested scopes. This was noted by
Andrew Koenig.
2001-12-03 21:47:37 +00:00
Fred Drake 1a76386194 Added documentation on the ScrolledText module. 2001-12-03 21:18:30 +00:00
Andrew M. Kuchling c54fc3179f Oops! Forgot the value parameter. 2001-12-03 20:58:29 +00:00
Andrew M. Kuchling 9455df2a5a Add __delete__ method of properties
Reflow paragraph
2001-12-03 20:55:37 +00:00
Fred Drake 1da50f6c6e Add a scalar product to the example list comprehensions based on a suggestion
sent to python-docs.
2001-12-03 18:54:33 +00:00
Fred Drake 5172adca81 Minor clarification of the zip() description, based on a comment sent to
python-docs.
2001-12-03 18:35:05 +00:00
Fred Drake 14f5c5fa01 Make no assumption about how modules are built when referring to them; this
can vary by platform and installation.
Based on suggestion to python-docs.
2001-12-03 18:33:13 +00:00
Fred Drake 1722e4a952 Re-word the intro slightly to avoid reader misunderstanding: strings are not
mutable!  We do not want to shock anyone.
This closes SF bug #483805.

Re-factor so that the description of the "access" keyword parameter is not
repeated in both the descriptions of mmap().  Also, only make sure the first
description of mmap() appears in the index.  The the index link is followed,
the first is now used to locate the page on the screen; chances are really good
both will be visible.  This avoids the problem that the index entry for the
second is selected and the first version is not visible, making the reader
consider that mmap() is not available on Windows.
2001-12-03 18:27:22 +00:00
Fred Drake 551ffae30c Clarify that the Python runtime may behave mysteriously when an exception
is not handled properly.
This closes SF bug #485153.
2001-12-03 17:56:09 +00:00
Fred Drake 3570551d6f Remove most references to __members__ and __methods__, leaving only one pair
of references that now state that these attributes have been removed,
directing the reader to the dir() function.
This closes SF bug #456420.
2001-12-03 17:32:27 +00:00
Fred Drake f07125ee53 PyErr_Format() does not return a new reference; it always returns NULL.
This closes SF bug #488387.
2001-12-03 16:36:43 +00:00
Fred Drake b22c6720aa Clean up some material that is not part of the standard documentation.
This closes SF bug #487308.
2001-12-03 06:12:23 +00:00
Fred Drake c7b78381da Another name. 2001-12-02 15:13:35 +00:00
Fred Drake d745b4e7a4 Add reference to the "String Methods" section to make that information
easier to find.  Based on the comment from Steve Alexander on the
zope-coders mailing list.
2001-12-02 15:10:46 +00:00
Fred Drake 381832ead5 Drop xmllib in favor of SAX. 2001-11-30 19:30:03 +00:00
Fred Drake 1e53fa7907 Add a couple of entries to the whitespace-cleanups table. 2001-11-30 19:25:39 +00:00
Fred Drake 0467775715 Add description of tkCommonDialog. 2001-11-30 19:24:49 +00:00
Fred Drake 95e33f03ba Added two new conversion specifications. 2001-11-30 19:06:18 +00:00
Fred Drake 10cd315963 Change the chapter title to reflect the Tk affinity.
Use the new seealso* environment in the section pointing out other GUI
toolkits.
2001-11-30 18:17:24 +00:00
Fred Drake 5ed35fd149 Add a new environment in the Python docs markup: seealso*. This is similar
to seealso, but does not add the "See also:" header or put the content in a
box in the HTML version.

Updated the description of \seeurl to better indicate when it should be used;
the old description was written before we had \seetitle.
2001-11-30 18:09:54 +00:00
Fred Drake 89d63cc450 Minor adjustments to markup for the getDOMImplementation() description. 2001-11-30 16:58:15 +00:00
Fred Drake bd34b6bc3d Added the convenience constants that are present in PyXML to make these
more similar.
2001-11-30 15:37:33 +00:00
Fred Drake 38f3b72f9f Updated documentation for the new httplib interface, by Kalle Svensson.
This closes SF bug #458447.
2001-11-30 06:06:40 +00:00
Fred Drake 454af89712 Update the signature of PyFile_WriteString(). 2001-11-29 22:42:59 +00:00
Fred Drake 44b6f84e56 More information about Tix support, contributed by Mike Clarkson. 2001-11-29 21:09:08 +00:00
Fred Drake 6995bb61b6 Various cleanups & markup fixes, mostly relating to the stat and statvfs
result object changes.
2001-11-29 20:48:44 +00:00
Fred Drake ed0a71911c Neil Schemenauer suggested a small improvement to one of the example REs. 2001-11-29 20:23:14 +00:00
Fred Drake 389aa17ad3 writeline() --> writelines()
This closes SF bug #487147.
2001-11-29 19:04:50 +00:00
Fred Drake 1cec7fab1d New section of regular expression examples contributed by Skip Montanaro,
with some extensions and changes from me.
This closes SF patch #472825.
2001-11-29 08:45:22 +00:00
Fred Drake 92024d1a99 Clarify the description of the creation of an owned reference from an API
function.
This closes SF bug #486657.
2001-11-29 07:16:19 +00:00
Fred Drake 99181ac64e Add an index entry for the discussion of PyEval_CallObject().
This is related to SF bug #485165.
2001-11-29 05:02:34 +00:00
Fred Drake ea4d2c0241 A few small changes:
- Change PREFIX to PREFIXES, which contains a sequence of prefix strings.
  This is useful since we want to look for both Py and PY.
- Wrap a long line.
- Collect struct tags as well as typedef names.  Since we generally only
  use one of the other, that improves coverage.
- Make the script executable on Unix.

This could use a better approach to determine if a symbol is documented,
and could easily avoid keeping the massive string in memory.  That would
take time to actually write more code, though, so we'll bail on that
for now.
2001-11-29 04:30:46 +00:00
Fred Drake 5107b4cf5f Re-arrange the modules in the "Internet Data Handling" chapter to try to
achieve a more sensible organization.
2001-11-28 07:50:45 +00:00
Fred Drake 6a6bb1828b Clarify that on some systems, lockf() using LOCK_EX requires that the file
is opened for writing; this closes SF bug #485342.

Added notes that file objects are also accepted in the place of file
descriptors.
2001-11-28 07:48:32 +00:00
Fred Drake 48704ee478 Add synopsis for the SimpleXMLRPCServer module; used in the chapter-level
list of modules.
2001-11-28 07:32:53 +00:00
Fred Drake c37b65ee10 Clean up some markup cruft. A number of the macros that take no
parameters (like \UNIX) are commonly entered using an empty group to
separate the markup from a following inter-word space; this is not
needed when the next character is punctuation, or the markup is the
last thing in the enclosing group.  These cases were marked
inconsistently; the empty group is now *only* used when needed.
2001-11-28 07:26:15 +00:00
Fred Drake beafc795df Typo, spotted by Fredrik Lundh. 2001-11-26 21:46:53 +00:00
Fred Drake b03d0cc45e Typo, spotted by Detlef Lannert. 2001-11-26 21:39:40 +00:00
Fred Drake fcb05ab512 Tk-related modules should no longer be listed here. 2001-11-26 21:38:50 +00:00
Fred Drake 2744f43f71 Fix typo, extra markup constructs.
This closes SF bug #485252.
2001-11-26 21:30:36 +00:00
Fred Drake cd8474e6a2 Add documentation for the PyCell* APIs. 2001-11-26 21:29:17 +00:00
Andrew M. Kuchling ccf04658b0 Correctly create new-style classes in the examples
Mention change to _PyTuple_Resize
2001-11-26 18:15:44 +00:00
Martin v. Löwis 560da62fc7 Rename get_referents to get_referrers. Fixes #483815. 2001-11-24 09:24:51 +00:00
Fred Drake 27ae311864 Avoid trailing blank lines in the output. 2001-11-19 05:28:29 +00:00
Fred Drake 00c96aeba6 Adjust input pre-processing so that a comment on the last line does not
break the processor; this will do the right thing.
2001-11-19 05:27:40 +00:00
Fred Drake e70dbe0fc5 Update the platform notes for the CGIHTTPServer module; it works on more
platforms now, and has since Python 2.0.
This closes SF bug #482943.
2001-11-19 05:16:35 +00:00
Fred Drake 63c4f907a9 Another name... 2001-11-19 04:35:58 +00:00
Fred Drake 7064d3b581 Fix the default value for feature_namespaces, per discussions on the XML-SIG
mailing list.  This causes the docs to match the default implementation.
2001-11-19 04:34:50 +00:00
Barry Warsaw 69ab5836ae Paul Rubin reminds me that of course a class's constructor /could/ get
called, if the pickler found a __getinitargs__() method.
2001-11-18 16:24:01 +00:00
Fred Drake ebbd14d7c2 Clarified a couple of issues for the startElement*() handlers:
- the attrs value may be re-used by the parser, so the implementation
  cannot rely on owning the object.
- an element with no namespace encountered in namespace mode will have a URI
  of None, not "" (startElementNS() only).

Fixed a couple of minor markup issues as well.
2001-11-18 04:58:28 +00:00
Tim Peters af0a883041 Relatively large expansion of the docs for gc.garbage. 2001-11-18 04:51:17 +00:00
Fred Drake ef6373a4f6 Exhibit good form in C code: always provide docstrings in method tables, and
always fill in all slots of table entries.
Fixed a few minor markup errors.
2001-11-17 06:50:42 +00:00
Fred Drake 50ecc15d05 Add omitted word for clarity. 2001-11-17 06:39:18 +00:00
Barry Warsaw 0c0565dd7f Toughen up the security warnings a bit. 2001-11-16 22:28:17 +00:00
Barry Warsaw 5e17d20743 Add a clarification that the email package always deals in native line
endings, and that it is smtplib's job to convert those to RFC 2821
line endings when sending the message.
2001-11-16 22:16:04 +00:00
Fred Drake dd2487d759 Post-release bumps. Do *NOT* merge into the 2.2b2 branch. 2001-11-16 17:34:38 +00:00
Fred Drake 666ca80b63 Clean up some markup a little bit more. Make this work with the PDF format,
which is a little more strict than the other formats on some things (fixable,
but not tonight).
2001-11-16 06:02:55 +00:00
Fred Drake 5545219bf6 Document the urlsplit() and urlunsplit() functions. 2001-11-16 03:22:15 +00:00
Fred Drake c66ff203bb Switched a couple of sections around.
Cleaned up some markup nits.
Add a few more of the Tk-related modules to the list of modules.
2001-11-16 01:05:27 +00:00
Barry Warsaw 69b2d75fc7 A few minor updates to make it clear(er) that pickle should be used
instead of marshal for object serialization.

Fred, please proofread!
2001-11-15 23:55:12 +00:00
Barry Warsaw f595fd975d A massive rewrite affecting both the pickle and cPickle module
documentation.  This addresses previously undocumented parts of the
public interfaces, the differences between pickle and cPickle,
security concerns, and on and on.

Fred please proofread!
2001-11-15 23:39:07 +00:00
Barry Warsaw d44e7ad702 Minor updates to add more pointers to the pickle documentation, and to
clarify some of the interface.
2001-11-15 23:37:26 +00:00
Fred Drake fd4f069b12 The turtle docs will be moving to another location in the Tkinter chapter. 2001-11-15 22:10:46 +00:00
Fred Drake 482b9a8c0c Clean up the descriptions of multi-signature functions so we do the right
thing in the index.
2001-11-15 20:41:03 +00:00
Fred Drake bc1491f60f Thanks for the Tkinter chapter, Mike! 2001-11-15 17:26:10 +00:00
Fred Drake 53556861df Add entries for the new Tkinter chapter. 2001-11-15 17:25:29 +00:00
Fred Drake 7cf4e5b329 Tkinter chapter, contributed by Mike Clarkson. Based in part on the "Tkinter
Life Preserver" by Matt Conway.
2001-11-15 17:22:04 +00:00
Fred Drake e1d4ad3a31 Finally commit the font changes that have been live on the development site
for a month or more.
2001-11-14 22:35:59 +00:00
Fred Drake 9c7a07f7a4 Bump release number & date. 2001-11-14 22:28:26 +00:00
Jeremy Hylton 1336e99054 Fred observes that the typo was not the only problem with this sentence. 2001-11-14 21:38:13 +00:00
Jeremy Hylton 4a98f70a09 typo 2001-11-14 21:32:27 +00:00
Tim Peters 5ebfd36afa CVS patch #477161: New "access" keyword for mmap, from Jay T Miller.
This gives mmap() on Windows the ability to create read-only, write-
through and copy-on-write mmaps.  A new keyword argument is introduced
because the mmap() signatures diverged between Windows and Unix, so
while they (now) both support this functionality, there wasn't a way to
spell it in a common way without introducing a new spelling gimmick.
The old spellings are still accepted, so there isn't a backward-
compatibility issue here.
2001-11-13 23:11:19 +00:00
Thomas Heller 64cdb48c80 No need to preprocess the header files - use ctags -I flag instead to
remove DL_IMPORT.
2001-11-12 12:52:01 +00:00
Thomas Heller bfeeeee851 Fix obvious typos. 2001-11-12 07:46:31 +00:00
Fred Drake 94ead57dc3 Added version annotations, remove hard tabs. 2001-11-09 23:34:26 +00:00
Jeremy Hylton 89c3a22a27 Add PyObject_CheckReadBuffer(), which returns true if its argument
supports the single-segment readable buffer interface.

Add documentation for this and other PyObject_XXXBuffer() calls.
2001-11-09 21:59:42 +00:00
Fred Drake da4ffeecf5 No need to have documentation for a module which not accepted in the library. 2001-11-09 21:45:55 +00:00
Barry Warsaw 3b0c82a2f1 Updated the documentation for formatdate(). 2001-11-09 17:08:13 +00:00
Thomas Heller 3988574075 Remove my name, probably bad style. 2001-11-09 17:04:43 +00:00
Thomas Heller 3e77423a64 Script to print undocumented symbols found in Python header files. 2001-11-09 16:50:35 +00:00
Fred Drake 30bd666c35 Cleaned up some markup stupidity and a usage problem reported by Detlef
Lannert.  Added descriptions of HTTP_PORT and HTTPS_PORT.
2001-11-09 05:03:05 +00:00
Fred Drake 399bc8c281 Fix a variety of typographical, grammatical, and clarity problems reported
by Detlef Lannert.
2001-11-09 03:49:29 +00:00
Fred Drake 0b66310476 When referring to a formal parameter from the description, use the name given
with the signature, not an ad hoc abbreviated form.
2001-11-07 06:28:47 +00:00
Fred Drake 59bfe280f5 Another name! 2001-11-07 06:23:27 +00:00
Fred Drake 66ded524ba apply() documentation: Remove a detail about the implementation that does
not affect the API.  Clean up the text about call syntax apply() is
equivalent to.  Based on comments by Thomas Guettler.
2001-11-07 06:22:25 +00:00
Fred Drake 1a670c8414 Adjust the module synopsis to avoid margin overruns in the PDF format. 2001-11-06 22:14:35 +00:00
Fred Drake 10b81ce4e5 A variety of small cleanups, including one to avoid a margin overrun in the
PDF version.
2001-11-06 22:13:19 +00:00
Fred Drake 5976816698 Remove stray quotes; probably left over from conversion from docstrings. 2001-11-06 22:11:34 +00:00
Fred Drake 806d332f02 Remove extra period. 2001-11-06 22:10:47 +00:00
Andrew M. Kuchling 1f774b062e Update obsolete e-mail address, and remove myself as a module author 2001-11-05 21:34:36 +00:00
Andrew M. Kuchling 4794f0b234 Update obsolete e-mail address 2001-11-05 21:31:33 +00:00
Andrew M. Kuchling 47ccfe2d8f Remove obsolete e-mail address 2001-11-05 21:31:15 +00:00
Andrew M. Kuchling f010df4ee5 Update URL, and remove e-mail address reference (readers can get it from
the Web page)
2001-11-05 21:30:10 +00:00
Andrew M. Kuchling 10f9c075b9 Remove obsolete e-mail address 2001-11-05 21:25:42 +00:00
Barry Warsaw 2bb077f630 Finally fleshed out the examples section with 4 code samples! Some of
my own doing, some originally written by Matthew Dixon Cowles.
2001-11-05 17:50:53 +00:00
Andrew M. Kuchling c44403995e Remove email*.tex subsections; they're all \input by email.tex 2001-11-05 01:55:43 +00:00
Andrew M. Kuchling 43dc1fc926 Minor grammar and typo fixes 2001-11-05 01:55:03 +00:00
Tim Peters 169ded0d68 Finish SF patch 477059: __del__ on new classes vs. GC.
Just doc and NEWS here, about the change in gc.garbage meaning.
2001-11-03 19:57:21 +00:00
Tim Peters 7533587d43 Improved error msg when a symbolic group name is redefined. Added docs
and NEWS.  Bugfix candidate?  That's a dilemma for Anthony <wink>:  /F
did fix a longstanding bug here, but the fix can cause code to raise an
exception that previously worked by accident.
2001-11-03 19:35:43 +00:00
Andrew M. Kuchling bc4a1c2588 [Patch #476612] Change docs to describe PEP247 interface 2001-11-02 21:44:09 +00:00
Fred Drake 622087a3ed Fix stupid bug recently introduced for DVI version of the docs (used to
generate PostScript).
2001-11-02 20:53:19 +00:00
Fred Drake d9272d6f11 Add deprecation notice to statcache. 2001-11-02 20:20:19 +00:00
Fred Drake 67bd68392c Make sure there are no weird nesting behaviors; the PDF version will not
format if there are (building the "bookmarks" for the reader breaks).
2001-11-02 19:41:23 +00:00
Fred Drake 3808045d00 Correct misspelling of "separate" in two places.
This closes SF bug #476898.
2001-11-01 19:48:01 +00:00
Andrew M. Kuchling 2dab9c7d9b Fix markup typo 2001-10-31 13:16:10 +00:00
Andrew M. Kuchling bbde5880a5 Add paragraph about difflib suggested by David Goodger
Bump version number
2001-10-31 13:13:36 +00:00
Andrew M. Kuchling 72a7fb78cb Fix grammar error 2001-10-30 22:18:21 +00:00
Andrew M. Kuchling 433b5c4d34 Rewrites and additions resulting from today's feedback 2001-10-30 21:36:04 +00:00
Fred Drake 345b8df2c4 Always use --dvips-safe when generating HTML for the standard documentation
since we do not have anything that causes dvips to be run except when
PostScript is specifically requested, which is a separate target.
2001-10-30 16:28:46 +00:00
Fred Drake 3ce28e4bd0 Add a new option, --dvips-safe, which sets the $DVIPS_SAFE option in
LaTeX2HTML.  This is not safe to do in general (for the reasons LaTeX2HTML
protects against dvips to begin with), but is safe if we do not actually
need to run dvips.  Note that we also assume it is safe if the user
specifically requests PostScript generation.  See the comments for further
explanation.
2001-10-30 16:09:51 +00:00
Andrew M. Kuchling 7aa63c245f Various minor rewrites
Bump version number
2001-10-30 14:35:03 +00:00
Andrew M. Kuchling 7cc13de554 Corrections noted by Michael McLay 2001-10-30 14:22:11 +00:00
Fred Drake 99de218cfc Promote file objects out of the "Other Objects" category, so they become
visible in the table of contents.
2001-10-30 06:23:14 +00:00
Fred Drake b4ea9d0502 Promote built-in functions to come before built-in types. 2001-10-30 06:22:02 +00:00
Tim Peters 003047a5f2 Mention the new file() builtin in the section on file objects. 2001-10-30 05:54:04 +00:00
Tim Peters a427a2b8d0 Rename "dictionary" (type and constructor) to "dict". 2001-10-29 22:25:45 +00:00
Fred Drake e59feb5edc Revise the PDF support in the LaTeX style sheet. This still isn't quite
right, but the tests for whether we are generating PDF are a bit more
readable, and some unnecessary indirection has been removed.
2001-10-29 21:02:28 +00:00
Andrew M. Kuchling 1117d930fa dictionary -> dict 2001-10-29 20:37:47 +00:00
Andrew M. Kuchling 4f9e220e7f Fix two typos noted by Jens Quade
Bump version number
2001-10-29 18:09:42 +00:00
Fred Drake 589abb7212 Add additional information on exceptions from time.mktime() and related to
improper time tuples passed to various functions.  Based on comments from
Andreas Jung.
2001-10-29 18:01:24 +00:00
Fred Drake 1b58bff8a0 More refcount information. 2001-10-29 17:43:14 +00:00
Fred Drake b0109ffb3b Ignore all *.tex files in the typesetting output directories since there are
a bunch of them now.
2001-10-29 17:42:17 +00:00
Fred Drake 520b0093db Make sure we generate versions of each file in the Python/C API manual with
reference-count annotations; this is needed for the typeset forms of the
manuals.
2001-10-29 17:40:40 +00:00
Andrew M. Kuchling 2836907bbb Fix some markup errors noted by MH
Use attribute assignment to illustrate __slots__ raising an error
2001-10-29 15:47:33 +00:00
Fred Drake b0c079e3e5 PyObject_CallFunctionObArgs() ---> PyObject_CallFunctionObjArgs()
PyObject_CallMethodObArgs() ---> PyObject_CallMethodObjArgs()
2001-10-28 02:39:03 +00:00
Andrew M. Kuchling cf31d5d5d0 Fill in remaining XXX spots
- Describe UnpackTuple()
        - Credit __unicode__ to MAL
Use \pep macro everywhere in body text.
   (Listening to "The Great Gate of Kiev" -- appropriately triumphal
    music for this check-in...)
2001-10-26 20:37:55 +00:00
Fred Drake e21e2bb121 Fix up a number of small problems with the DOM documentation.
There's still a lot to do, but it's better now.
2001-10-26 20:09:49 +00:00
Andrew M. Kuchling b83769cb82 Finish off the type/class section; I don't think there's much else
to be covered in an overview article like this.
2001-10-26 20:07:03 +00:00
Fred Drake 41cf5e0069 Remove unused variable. 2001-10-26 19:50:26 +00:00
Fred Drake ef428a292a Explain what [].insert() does when the target index is negative. 2001-10-26 18:57:14 +00:00
Fred Drake d5be3b75dd Add notes pointing out that these classes are kept for backward compatibility
and suggeest that new code that does not require compatibility with older
Python versions subclass dictionary, list, or str.
2001-10-26 18:37:27 +00:00
Fred Drake 7408da54e2 Many, many small fixes and improvements, most suggested by Detlef Lannert. 2001-10-26 17:40:22 +00:00
Fred Drake c44e9eca66 Added docs for PyObject_CallFunctionObArgs() and PyObject_CallMethodObArgs().
Minor cleanups & markup consistency fixes.
2001-10-26 16:38:38 +00:00
Fred Drake 81c7aa2c7b Added refcount data for PyObject_CallFunctionObArgs() and
PyObject_CallMethodObArgs().
2001-10-26 16:29:22 +00:00
Fred Drake ef7d08a661 Some style changes and typo fixes. 2001-10-26 15:04:33 +00:00
Fred Drake fb6499fd9c Clean up the tables of child links generated by stock LaTeX2HTML so we get
consistent (lack of) vertical space between sections, and remove some of the
unnecessary cruft that was added in (finally we get to *remove* something
that got generated!).
2001-10-26 14:16:23 +00:00
Fred Drake de3d060eb2 Typo: destuction --> destruction
Reported by Thomas Heller.
2001-10-26 11:27:54 +00:00
Tim Peters 1fc240e851 Generalize dictionary() to accept a sequence of 2-sequences. At the
outer level, the iterator protocol is used for memory-efficiency (the
outer sequence may be very large if fully materialized); at the inner
level, PySequence_Fast() is used for time-efficiency (these should
always be sequences of length 2).

dictobject.c, new functions PyDict_{Merge,Update}FromSeq2.  These are
wholly analogous to PyDict_{Merge,Update}, but process a sequence-of-2-
sequences argument instead of a mapping object.  For now, I left these
functions file static, so no corresponding doc changes.  It's tempting
to change dict.update() to allow a sequence-of-2-seqs argument too.

Also changed the name of dictionary's keyword argument from "mapping"
to "x".  Got a better name?  "mapping_or_sequence_of_pairs" isn't
attractive, although more so than "mosop" <wink>.

abstract.h, abstract.tex:  Added new PySequence_Fast_GET_SIZE function,
much faster than going thru the all-purpose PySequence_Size.

libfuncs.tex:
- Document dictionary().
- Fiddle tuple() and list() to admit that their argument is optional.
- The long-winded repetitions of "a sequence, a container that supports
  iteration, or an iterator object" is getting to be a PITA.  Many
  months ago I suggested factoring this out into "iterable object",
  where the definition of that could include being explicit about
  generators too (as is, I'm not sure a reader outside of PythonLabs
  could guess that "an iterator object" includes a generator call).
- Please check my curly braces -- I'm going blind <0.9 wink>.

abstract.c, PySequence_Tuple():  When PyObject_GetIter() fails, leave
its error msg alone now (the msg it produces has improved since
PySequence_Tuple was generalized to accept iterable objects, and
PySequence_Tuple was also stomping on the msg in cases it shouldn't
have even before PyObject_GetIter grew a better msg).
2001-10-26 05:06:50 +00:00
Fred Drake af07b2c34f Add yet more markup that let's a stylesheet pick out a small bit of the
presentation.  This is acceptable since it only occurs in the formatted
output and does not affect the document markup.
2001-10-26 03:09:27 +00:00
Fred Drake 7f10cce4c1 Enforce a bit of markup consistency.
When describing a Boolean return value, use "true" and "false" instead of
"1" and "0".
Style-guide conformance:  no "iff" -- to obscure for many readers.  ;-(
2001-10-26 03:04:23 +00:00
Fred Drake 3a2c462436 Minor textual adjustment, and style-guide conformance (no use of "iff"). 2001-10-26 03:00:39 +00:00
Barry Warsaw 107771a228 Applying proposed patch for bug #474583, optional support for
non-standard but common types.  Including Martin's suggestion to add
rejected non-standard types from patch #438790.  Specifically,

guess_type(), guess_extension(): Both the functions and the methods
grow an optional "strict" flag, defaulting to true, which determines
whether to recognize non-standard, but commonly found types or not.

Also, I sorted, reformatted, and culled duplicates from the big
types_map dictionary.  Note that there are a few non-equivalent
duplicates (e.g. .cdf and .xls) for which the first will just get
thrown away.  I didn't remove those though.

Finally, use of the module as a script as grown the -l and -e options
to toggle strictness and to do guess_extension(), respectively.

Doc and unittest updates too.
2001-10-25 21:49:18 +00:00
Fred Drake 61f794918f Typo: NamedNodeList --> NamedNodeMap 2001-10-25 20:42:57 +00:00
Fred Drake 847c51a181 Slightly better conformance to the Python C style guide. 2001-10-25 15:53:44 +00:00
Fred Drake af876d77e0 One more LaTeX-ism that we'd rather ignore. 2001-10-25 15:14:57 +00:00
Fred Drake a281665972 No need to run make twice here. 2001-10-25 15:13:30 +00:00
Fred Drake 0099d8f8fb Update the rules so that changes to the HTML stylesheet cause appropriate
work to be done, but do not require the HTML to be re-built.
2001-10-25 15:12:31 +00:00
Fred Drake bc006af3d0 Make the deprecation notice use the same form as other such notices.
This has sat around in a deprecated state for a *long* time!
2001-10-24 21:56:59 +00:00
Fred Drake 0559d95fd6 Minor revision of the text. 2001-10-24 21:10:52 +00:00
Fred Drake 08fd51509c When describing "import *", add a level of indirection between "*" and the
set of names imported (the "public names"), adding a definition of "public
names" that describes the use of __all__.
This closes SF bug #473986.

Flesh out the vague reference to __import__().
2001-10-24 19:50:31 +00:00
Fred Drake c84f2c5068 Documentation for the new PyArg_UnpackTuple() function. 2001-10-23 21:10:18 +00:00
Andrew M. Kuchling 4855b02554 Fill out section on how to write a new-style class 2001-10-23 20:26:16 +00:00
Tim Peters 98791affc8 Doc and NEWS changes due to Jeremy adding traceback objects to gc. 2001-10-23 01:59:54 +00:00
Barry Warsaw d05e051aa7 Fixed an example in the use of email.Utils.getaddresses(). The
failobj has to be a list or the `+' can fail.
2001-10-22 20:53:45 +00:00
Fred Drake a219b411af Add better support for Mozilla's use of <link> elements. 2001-10-22 16:57:49 +00:00
Andrew M. Kuchling 32e3232a55 Update bug/patch counts 2001-10-22 15:32:05 +00:00
Fred Drake f10584cb11 Do a little bit more to try and add <link> elements to the header, not that
Mozilla 0.9.5 can make intelligent use of them.  Specifically, this causes
the "Acknowledgements" and "Global Module Index" pages to acquire "up"
links in the Mozilla "Site Navigation Bar".
This partially responds to SF bug #469772.
2001-10-22 15:07:16 +00:00
Fred Drake 5d9a6b575c Clarify that the resource module does not attempt to mask platform
differences by defining symbols not defined on particular platforms.
This closes SF bug #473433.
2001-10-22 14:18:23 +00:00
Andrew M. Kuchling beb385568c Add correction from /F about SRE
\filename{} should be \file{}
2001-10-22 14:11:06 +00:00
Andrew M. Kuchling 279e744573 Partly fill out the PEP 252 section 2001-10-22 02:03:40 +00:00
Andrew M. Kuchling 8b42f01667 A bunch of minor rewordings 2001-10-22 02:00:11 +00:00
Andrew M. Kuchling 9dbc0bcf9d Update description of border() 2001-10-20 16:07:41 +00:00
Fred Drake 0aa811c527 Use the \note and \warning macros where appropriate. 2001-10-20 04:24:09 +00:00
Fred Drake 64a5aaf05c Describe the content given as the parameter to the \note and \warning macros
in more detail, and use them where appropriate.
2001-10-20 04:18:14 +00:00
Fred Drake 0c77cf15c0 Additional rules to support the iSilo conversion. 2001-10-19 21:12:57 +00:00
Fred Drake 5a4bdb7be8 Hush up CVS. 2001-10-19 21:09:19 +00:00
Fred Drake cc2e306592 Support for the iSilo conversion. 2001-10-19 21:08:36 +00:00
Fred Drake aad8bb5d7a When stating that some parameters to makefile() are similar to the open()
parameters, given a hyperlink to the right part of the documentation to
make it easier to look those up.  Also, refer to the file() function/
constructor instead of open() now that that is where the actual docs for
those parameters live.
This closes SF bug #472004.
2001-10-19 17:22:29 +00:00
Marc-André Lemburg b5507ecd3c Additional test and documentation for the unicode() changes.
This patch should also be applied to the 2.2b1 trunk.
2001-10-19 12:02:29 +00:00
Barry Warsaw e736d93eab Added a note about the somewhat kludgey behavior of the message
epilogue, based on the discussion in this SF bug report:

https://sourceforge.net/tracker/index.php?func=detail&aid=472481&group_id=25568&atid=384678
2001-10-19 04:34:42 +00:00
Guido van Rossum b6c1d5239c SF patch #443759: Add Interface to readline's add_history
This was submitted by Moshe, but apparently he's too busy to check it
in himself.  He wrote:

    Here is a function in GNU readline called add_history,
    which is used to manage the history list. Though Python
    uses this function internally, it does not expose it to
    the Python programmer. This patch adds direct interface
    to this function with documentation.

    This could be used by friendly modules to "seed" the
    history with commands.
2001-10-19 01:18:43 +00:00
Fredrik Lundh a5e616510e changed misleading argument name 2001-10-18 20:58:25 +00:00
Barry Warsaw 91b81c4802 Some minor clarifications for find()'s arguments based on SF bug
#463572.  Closing.
2001-10-18 19:41:48 +00:00
Fred Drake db7287c0f5 Straighten out the exec*() function descriptions a bit, and clarify a few
points in the spawn*() description.
2001-10-18 18:58:30 +00:00
Fred Drake 9ae09947f4 Bump version number.
Remove inconsistent use of HTMLDIR.
2001-10-18 18:46:22 +00:00
Fred Drake 77165d039f Bump release information. 2001-10-18 18:41:12 +00:00
Fred Drake 316141b333 Fix typo reported by Michael Soulier. 2001-10-18 15:22:23 +00:00
Fred Drake ca836f7e65 Function descriptions must end as well as start! 2001-10-18 14:26:08 +00:00
Martin v. Löwis c405133fce Elaborate on types and meaning of the setgroups arguments. 2001-10-18 14:07:12 +00:00
Martin v. Löwis 61c5edf6fc Expose setgroups. Fixes feature request #468116. 2001-10-18 04:06:00 +00:00
Tim Peters 61acf067ac SF bug [#471111] inspect.getframeinfo() needs docs.
TeX-ified its docstring.
2001-10-16 23:01:06 +00:00
Guido van Rossum 3c28863e08 Partial patch from SF #452266, by Jason Petrone.
This changes Pythread_start_thread() to return the thread ID, or -1
for an error.  (It's technically an incompatible API change, but I
doubt anyone calls it.)
2001-10-16 21:13:49 +00:00
Jeremy Hylton 511e2cacc4 [ #403753 ] zlib decompress; uncontrollable memory usage
Mostly by Toby Dickenson and Titus Brown.

Add an optional argument to a decompression object's decompress()
method.  The argument specifies the maximum length of the return
value.  If the uncompressed data exceeds this length, the excess data
is stored as the unconsumed_tail attribute.  (Not to be confused with
unused_data, which is a separate issue.)

Difference from SF patch: Default value for unconsumed_tail is ""
rather than None.  It's simpler if the attribute is always a string.
2001-10-16 20:39:49 +00:00
Guido van Rossum 7a59445e37 Document required return values -1, 0, 1 for tp_compare handler, as
suggested in SF patch #424475.  Also document exception return.
2001-10-16 20:32:05 +00:00
Fred Drake 5bf1ecd503 Update the description of PyTrace_EXCEPT. 2001-10-16 19:23:55 +00:00
Fred Drake ab9b238ced Fix a few usage and style-guide conformance issues. 2001-10-16 19:22:51 +00:00
Fred Drake 64d7863797 Added information about setprofile() and settrace() hooks being thread-
specific, and updated some of the comments about the profile hook.
This closes SF bug #471725.
2001-10-16 14:54:22 +00:00
Fred Drake a815916472 Fix thinko in a comment about seeking with a file object.
Reported by Francesco Trentini.
2001-10-16 03:25:00 +00:00
Fred Drake 327798ca4a Added notes to clarify that binascii.crc32(), zlib.crc32(), and
zlib.adler32() are not suitable as general hash functions.
2001-10-15 13:45:49 +00:00
Fred Drake 0fae49fc7b Added documentation for the functions listed in marshal.h.
Prompted by Jim Ahlstrom.  This closes SF patch #470614.
2001-10-14 04:45:51 +00:00
Fred Drake c65b3d95b6 Add entries for the newly split C API manual. 2001-10-12 19:02:35 +00:00
Fred Drake 3adf79e3e2 Break the Python/C API manual into smaller files by chapter. This manual
has grown beyond what font-lock will work with using the default (X)Emacs
settings.

Indentation of the description has been made consistent, and a number of
smaller markup adjustments have been made as well.
2001-10-12 19:01:43 +00:00
Jeremy Hylton cb43c085e2 Document that keyfile and certfile are now optional.
XXX Forgot to mention this in the last socketmodule.c checkin.
2001-10-11 16:17:22 +00:00