Commit Graph

5025 Commits

Author SHA1 Message Date
Fred Drake a65375c3e3 Explain what os.read() returns at end of file.
This closes SF bug #550409.  Applying to release21-maint & release22-maint.
2002-05-01 03:31:42 +00:00
Fred Drake 7938fab285 Add missing right-parenthesis. 2002-05-01 03:23:03 +00:00
Skip Montanaro d268183044 moved from Tools/scripts (was only at rev 1.1 - no changes yet - so I simply
removed it from there and added it here)
2002-04-30 16:25:37 +00:00
Fred Drake 52cc670711 Add a note about when the "%r" formatting code was added. 2002-04-30 14:54:47 +00:00
Fred Drake af93c4c8d9 Added a missing "|" in the grammar productions used in the reference manual
(reported by François Pinard).
Added some missing "_" characters in the same cluster of productions.
Added missing floor division operator in m_expr production, and mention
floor division in the relevant portion of the text.
2002-04-30 02:18:51 +00:00
Thomas Heller 541703b18f Typo: whcar_t should be wchar_t.
Bugfix candidate? Don't know how this is handled in the docs.
2002-04-29 17:28:43 +00:00
Andrew M. Kuchling b803f7013c Add some items, and remove a note to myself 2002-04-29 15:42:16 +00:00
Fred Drake 432425e834 Small markup adjustments for consistency. 2002-04-29 15:17:16 +00:00
Tim Peters 81b9251d59 Mostly in SequenceMatcher.{__chain_b, find_longest_match}:
This now does a dynamic analysis of which elements are so frequently
repeated as to constitute noise.  The primary benefit is an enormous
speedup in find_longest_match, as the innermost loop can have factors
of 100s less potential matches to worry about, in cases where the
sequences have many duplicate elements.  In effect, this zooms in on
sequences of non-ubiquitous elements now.

While I like what I've seen of the effects so far, I still consider
this experimental.  Please give it a try!
2002-04-29 01:37:32 +00:00
Tim Peters 5de9842b34 Repair widespread misuse of _PyString_Resize. Since it's clear people
don't understand how this function works, also beefed up the docs.  The
most common usage error is of this form (often spread out across gotos):

	if (_PyString_Resize(&s, n) < 0) {
		Py_DECREF(s);
		s = NULL;
		goto outtahere;
	}

The error is that if _PyString_Resize runs out of memory, it automatically
decrefs the input string object s (which also deallocates it, since its
refcount must be 1 upon entry), and sets s to NULL.  So if the "if"
branch ever triggers, it's an error to call Py_DECREF(s):  s is already
NULL!  A correct way to write the above is the simpler (and intended)

	if (_PyString_Resize(&s, n) < 0)
		goto outtahere;

Bugfix candidate.
2002-04-27 18:44:32 +00:00
Fred Drake d3e6678713 Slightly expand and clarify the differences between getegid(), getgid(),
getpgrp(), and setpgid().
This closes SF bug #547939.
2002-04-26 20:59:40 +00:00
Fred Drake a7bb2b9b30 Be more consistent, both internally and with recommended practice.
This closes SF bug #547953.
2002-04-26 20:44:14 +00:00
Fred Drake 38f71973e5 Documentation for the enumerate() function/type.
This closes SF patch #547162.
2002-04-26 20:29:44 +00:00
Thomas Heller 8da4b59221 Fix a small mistake and complete some function prototypes.
SF Patch #547813.
2002-04-24 06:35:11 +00:00
Fred Drake 99d17006c1 Add text about circular references caused by storing frames in local
variables.  This closes SF bug #543148.
2002-04-23 21:21:20 +00:00
Fred Drake ed9e453eb7 Minor change to an index entry. 2002-04-23 20:04:46 +00:00
Fred Drake b957bc3dcc Clarify the return value of PyObject_IsInstance(). 2002-04-23 18:15:44 +00:00
Fred Drake 106c1a0e7a WCOREDUMP(), WIFCONTINUED(), WCONTINUED, WUNTRACED: New.
isatty(), WIFEXITED(), WIFSIGNALED(), WIFSTOPPED(): Changed to return
    bools instead of ints.
2002-04-23 15:58:02 +00:00
Anthony Baxter 8388895fe4 SF patch [ 545523 ] patch for 514433 bsddb.dbopen (NULL)
closes SF #514433

can now pass 'None' as the filename for the bsddb.*open functions,
and you'll get an in-memory temporary store.

docs are ripped out of the bsddb dbopen man page. Fred may want to
clean them up.

Considering this for 2.2, but not 2.1.
2002-04-23 02:11:05 +00:00
Walter Dörwald de02bcb265 Apply patch diff.txt from SF feature request
http://www.python.org/sf/444708

This adds the optional argument for str.strip
to unicode.strip too and makes it possible
to call str.strip with a unicode argument
and unicode.strip with a str argument.
2002-04-22 17:42:37 +00:00
Tim Peters 4a0db06edf Hack around the "2.1.6 Blank lines" bug in a way that the TOC still
displays a recognizable section title (there are extra blanks at the
end of it now, due to the nested anchor, but that's fine).
2002-04-21 04:44:11 +00:00
Tim Peters dc374e034a Give the Help viewer a font-size button. This isn't documented by MS,
but is documented by others on the web, and the defn of the magic flag
needed appears in MS's htmlhelp.h header file.
2002-04-21 02:01:01 +00:00
Tim Peters c8490c70cd Move "everything left one": the TOC now shows each doc directory as a
distinct top-level node.  Before they were all nested under an artificial
top-level node, uselessly chewing up horizontal space, and ensuring that
the only thing the user saw in the TOC upon opening the file was a single
collapsed top-level folder.
2002-04-20 21:34:34 +00:00
Tim Peters 4545407746 Stopped all warnings from the HTML Help Compiler, by generating proper
HTML (or, at least, proper in its view).  The TOC file is now identical
to what the HTML compiler itself generates, except for whitespace and
a glitch identified below.  The pretty-printing done by prechm.py is
pretty much destroyed for now; if you need it pretty-printed, just make
the Help Compiler save the files (it's got its own idea of pretty-
printing anyway).

Glitch:  The title of Ref Man "2.1.6 Blank lines" shows up as a blank
for now.  This is because the relevant entry in ref/index.html contains
nested anchors, and pychm really has no idea what to do with that.  I
hacked it for now to avoid any error messages or worse insanity, and
filed a bug report against the docs.
2002-04-20 20:26:26 +00:00
Tim Peters e21095e3c5 Widespread: Used classes in a more natural way. Added convenience
methods to squash code duplication.  Simplified several overly complex
chunks of logic.  Built output strings more with string interpolation
instead of infix '+'.  Added comments.  Exploited recent Python features
(chiefly bool and augmented assignment).
2002-04-20 08:36:42 +00:00
Tim Peters d9a10509ac Replaced the fiddly 5-tuples with a new Book convenience class, allowing
to reference fields via names instead of meaningless little integers.
This turned up one case where the wrong little integer was being used,
in informative progress output.  Fixed that too.
2002-04-20 03:25:02 +00:00
Tim Peters 8d62ad7ffd Fixed a comment. 2002-04-20 02:56:20 +00:00
Tim Peters 661e49231a All over: get rid of blanks before colons that open code blocks. 2002-04-20 02:39:44 +00:00
Tim Peters 460643b8c5 do_project(): Modernized the code. 2002-04-20 02:37:07 +00:00
Tim Peters 5d5e1930dd Added "What's New" to the 2.2 doc set. 2002-04-20 02:07:58 +00:00
Tim Peters 4f109c1cf9 Added a stop-list to reduce the size of the full text search index. Fred,
populate the "stop_list" triple-quoted string with your favorite handful
of stop words.
2002-04-19 18:41:46 +00:00
Tim Peters e6b63e685b project_template: use dict interpolation instead of giant tuples. 2002-04-19 18:07:52 +00:00
Tim Peters a905363ce5 + Changed TOC to folder-tree style.
+ Increased size of the window the user sees the first time.
+ Arranged for the display to remember its last size and position.
+ Added a Favorites (bookmarks) tab.
+ Added the "Advanced Search" decorations.
2002-04-19 16:46:43 +00:00
Tim Peters 52cfa33e6e Generates inputs to the Microsoft Help Compiler, which creates compiled
HTML help files (.chm).  Obtained from Robin Dunn's packaging of the
2.2 docs at <http://alldunn.com/python/>, obtained in turn from
Hernán Martínez Foffani's original work at
<http://www.orgmf.com.ar/condor/pytstuff.html>.
2002-04-19 16:09:26 +00:00
Tim Peters 7d4ed0db95 Get the right funny characters in Hernan's name. 2002-04-19 15:59:01 +00:00
Skip Montanaro 75700db7f0 \idxcode -> \py@idxcode (mimics index stuff in python.sty - problem only
revealed itself when i added index generating lines to doc/doc.tex)
2002-04-19 04:52:44 +00:00
Skip Montanaro 176bda4cde fix duplicate label
add index turds
2002-04-19 04:50:44 +00:00
Fred Drake c55ae4b98c Clean up the use of version numbers in filenames; always use an "abstract"
version number, and explain what it is at the top of the chapter.
This closes SF bug #225003.
2002-04-19 04:04:57 +00:00
Andrew M. Kuchling 91bae441f6 Long-forgotten change: Update first paragraph with actual release date 2002-04-18 02:18:27 +00:00
Skip Montanaro b02ea65f92 typo 2002-04-17 19:33:06 +00:00
Fred Drake 8d95ca4469 Add text on tp_as_buffer that refers tothe section that covers the topic.
Additional material is still needed in that section.
2002-04-17 13:44:58 +00:00
Fred Drake 933f159a2f Add a version annotation for the help() function. 2002-04-17 12:54:04 +00:00
Fred Drake 70b3831697 Adjust markup to worm around tool limitations; the "m" in "model" was being
dropped in the HTML formatted version.
Reported by Mike Coleman.
2002-04-17 03:41:50 +00:00
Fred Drake 3d0b697d70 Pass the -r option to getpagecounts to generate an entry for the "What's
New" document.
2002-04-17 03:31:08 +00:00
Fred Drake bab5aa0039 Remove Emacs turd; not needed with modern Emacs versions.
Add a -r option; if given with a release number, the "What's New" document
is included with the relevant version number.

Update the text of the README distributed with the PostScript files to
reflect the changes in the user organizations in the Python community.
2002-04-17 03:29:40 +00:00
Fred Drake 1f6794622b Changed last remaining use of "./" to "index.html" when referring to the
index file for the top-level directory.  This makes it easier to use an
unpacked version of the documentation via file: URLs.
This closes SF bug #541257.
2002-04-17 01:40:56 +00:00
Fred Drake 34a05f7a1f Start of script to locate C symbols and segregate them into lists of
the documented and undocumented symbols.
2002-04-16 21:27:17 +00:00
Fred Drake 0fdc826f54 Update the dependencies. 2002-04-16 18:48:25 +00:00
Fred Drake 121460d8cb Minor wording change. 2002-04-16 18:32:37 +00:00
Fred Drake 9ad70f9cb0 Add more text from Guido on the type structure fields.
Small additional changes.
2002-04-16 16:22:24 +00:00
Skip Montanaro 6c7bc31089 added small clarification to the descriptions of encode() and decode() 2002-04-16 15:12:10 +00:00
Thomas Heller 0e661dcdbf Replace the simpleminded string.find with a re.search looking only for
full words. Before that, something like 'PyObject_Call' was missed
because 'PyObject_CallFunction' was found.

Passes PyChecker now.
2002-04-16 15:04:56 +00:00
Fred Drake c0a02c084b Remove repeated index entry; adds nothing different.
Closes SF bug #518985.
2002-04-16 02:03:05 +00:00
Fred Drake 0e0b6180ba Add documentation for PyObject_Call().
Note that PyObject_Size() is a synonym for PyObject_Length().
This closes SF patch #544330 (contributed by Thomas Heller).
2002-04-15 20:51:19 +00:00
Fred Drake 34adb8a8ec Separate out a \cfuncline macro from the cfuncdesc environment.
This matches many other of the *desc environments, and is useful when
multiple functions share a description.
2002-04-15 20:48:40 +00:00
Fred Drake 1251b0eb24 Document the cmemberdesc environment. 2002-04-15 20:10:23 +00:00
Fred Drake 8a5a270000 Better documentation for GetArgv() and the ProgressBar type.
Back-porting to release22-maint.
This closes SF patch #496705.
2002-04-15 19:53:35 +00:00
Fred Drake e19a5bcc7b Be consistent in presenting the signatures. 2002-04-15 19:46:40 +00:00
Fred Drake 154985587b Add docs for os.fchdir(). 2002-04-15 19:41:27 +00:00
Fred Drake 0157276cf8 Generate the right annotations in the index entries.
Thanks to Thomas Heller for the sharp eye.
2002-04-15 19:35:29 +00:00
Fred Drake 188ecd141a Integrated more text from Guido. 2002-04-15 18:44:46 +00:00
Fred Drake c63042bcc4 Move the listing of the type structure, since both the C API reference and
the Extending & Embedding manual use it.
2002-04-15 18:43:20 +00:00
Fred Drake 8a5e6790d9 Clean up the application of style to verbatim text.
This moves styling to the stylesheet; the use of <dl> structures to control
style sometimes produced improper indentation of subsequent text in many
browsers when the text was already part of the <dl> structure (as in a
function or class description).
2002-04-15 18:41:31 +00:00
Fred Drake eeb5ec42e0 Add support for \cmemberline and the cmemberdesc environment. 2002-04-15 17:46:00 +00:00
Andrew M. Kuchling 8e8af6e722 Add item 2002-04-15 14:05:59 +00:00
Walter Dörwald 068325ef92 Apply the second version of SF patch http://www.python.org/sf/536241
Add a method zfill to str, unicode and UserString and change
Lib/string.py accordingly.

This activates the zfill version in unicodeobject.c that was
commented out and implements the same in stringobject.c. It also
adds the test for unicode support in Lib/string.py back in and
uses repr() instead() of str() (as it was before Lib/string.py 1.62)
2002-04-15 13:36:47 +00:00
Neal Norwitz b384c72639 posix.mknod() and {}.pop() were added 2002-04-15 12:46:11 +00:00
Andrew M. Kuchling f367651472 Add items 2002-04-15 02:27:55 +00:00
Martin v. Löwis 06a83e90aa Patch #543447: Add posix.mknod. 2002-04-14 10:19:44 +00:00
Fred Drake 8b1c47bb8b Document the optional argument to the .strip(), .rstrip(), .strip() string
methods.
Part of SF feature #444708.
2002-04-13 02:43:39 +00:00
Fred Drake 01e94618f5 Additional support for describing C structure members. 2002-04-12 22:48:02 +00:00
Fred Drake 4d2a95dfe7 Integrate a bunch of new text from Guido. 2002-04-12 22:47:18 +00:00
Fred Drake d4c0e5fd5b BDFL agreed with Tim: rehabilitate randint(). 2002-04-12 20:01:47 +00:00
Fred Drake fd92304ae8 Update the type of the tp_free slot. 2002-04-12 19:49:13 +00:00
Fred Drake f495ef7466 Warn people away from PyModule_GetDict(), but not too strongly.
(The real issue is whether modules can benefit from an alternate
implementation strategy rather than using a dictionary.  We should migrate
away from direct dictionary manipulation to allow more room for Jeremy to
flex the implementation with changes in globals lookup.)
2002-04-12 19:32:07 +00:00
Fred Drake 63e40a598d Do not use PyModule_GetDict().
Clean up the example of exporting a C-callable API from an extension module.
Add a hyperlink to a related section in the Python/C API reference.
2002-04-12 19:08:31 +00:00
Fred Drake e77e5ef2af Change example of retrieving & calling a Python function to not use
PyModule_GetDict(), which is also more flexible: it does not assume that the
"module" is a real module.
2002-04-12 19:04:17 +00:00
Fred Drake 292da58a5c Change the type of the tp_dealloc back to what it really is.
Change a section title to fit in better.
2002-04-12 18:28:08 +00:00
Fred Drake ee48519bc6 Modernize the minimal example of an extension type. 2002-04-12 16:17:06 +00:00
Fred Drake 28de8d4b37 Add a (very) simple description of PyType_Ready(). 2002-04-12 16:15:10 +00:00
Fred Drake 0babc44ab2 Update the type of tp_dealloc. 2002-04-12 15:37:43 +00:00
Guido van Rossum e027d9818f Add Raymond Hettinger's d.pop(). See SF patch 539949. 2002-04-12 15:11:59 +00:00
Martin v. Löwis 2a519f8fe6 Document __unicode__. Fixes #541245. 2002-04-11 12:39:35 +00:00
Martin v. Löwis 81bdc93d2f Explain octal escapes. Fixes #542226. 2002-04-11 12:24:12 +00:00
Andrew M. Kuchling 17850f79a8 Add a name 2002-04-10 21:53:22 +00:00
Andrew M. Kuchling 2854c478be Remove mention of 'pre' module
(2.2 bugfix candidate?)
2002-04-10 21:28:31 +00:00
Fred Drake e3c764b6c2 Document PyType_CheckExact(), PyType_IS_GC().
Update description of PyType_Check().
2002-04-10 17:52:52 +00:00
Skip Montanaro 3b2625ff82 document all the valid encoding values 2002-04-10 04:37:09 +00:00
Fred Drake 3c1ff5c766 When adding a name to the table of macros and environments, make sure it
is not already present.  If it is, raise an exception, since that should not
happen in a well-defined conversion.
2002-04-10 04:20:33 +00:00
Fred Drake 0047e16d1b Added support for \csimplemacro and csimplemacrodesc. 2002-04-10 04:19:12 +00:00
Fred Drake 4d61775a35 Started filling in the information about some of the basic types and macros
used to define Python objects.
2002-04-09 21:22:07 +00:00
Fred Drake 375e30225e Update to use the new \csimplemacro macro 2002-04-09 21:09:42 +00:00
Fred Drake 79bf99c505 Document the \csimplemacro macro and the csimplemacrodesc environment. 2002-04-09 20:17:42 +00:00
Fred Drake 19f827e765 Add \csimplemacro to parallel the csimplemacrodesc environment.
Fix a typo in the comments for csimplemacrodesc.
2002-04-09 20:16:47 +00:00
Neal Norwitz 6b35370c65 Update docs for bool changes by Guido around April 6 2002-04-09 18:15:00 +00:00
Fred Drake eee12e9aba Ignore an output directory for intermediates here as well. 2002-04-09 14:54:26 +00:00
Fred Drake fd867719bc Fix typo: coverted --> converted. Reported by Francois Pinard. 2002-04-09 14:39:10 +00:00
Fred Drake 77f4438f1a Update the table of releases. 2002-04-08 21:57:31 +00:00
Martin v. Löwis 688357e035 Patch #512005: getrusage() returns struct-like object. 2002-04-08 21:28:20 +00:00
Fred Drake bc82ab1c9f Do not call "knee" a standard module, and point to the new location.
This addresses the issue in SF bug #515745.
2002-04-08 05:22:30 +00:00
Tim Peters 87bbdd3085 Minor clarification about what's actually promised for PyMem_Malloc(0).
I probably didn't do a correct thing for the LaTeX spelling of the
integer 1.
2002-04-06 09:14:33 +00:00
Fred Drake 68304ccce3 Move reference material on PyArg_Parse*() out of the Extending & Embedding
document to the C API reference.  Move some instructional text from the API
reference to the Extending & Embedding manual.

Fix the descriptions of the es and es# formats for PyArg_Parse*().
This closes SF bug #536516.
2002-04-05 23:01:14 +00:00
Fred Drake 9651198db4 Remove weird spacing in typeset version of the chapter head. 2002-04-05 19:54:19 +00:00
Fred Drake d15a0a05d3 Fix bug in command line handling, noted by Fredrik Lundh. 2002-04-05 18:09:22 +00:00
Fred Drake e03e1fe5cc Add support for the "Aesop Meta Tag". Not widely used, but not a bad idea,
either.
2002-04-05 17:34:50 +00:00
Neal Norwitz d3dab2b192 Update doc to reflect Tim's changes to bool. 2002-04-05 02:21:09 +00:00
Fred Drake a8e5d432a5 Minor style change. 2002-04-04 22:56:57 +00:00
Fred Drake 9b3e2ca74d Add support for \textgreater, \textless.
Updated productionlist environment.
2002-04-04 21:39:42 +00:00
Fred Drake a2c2595024 Add a version annotation regarding the urlopen(proxies={...}). 2002-04-04 20:58:02 +00:00
Fred Drake 5ca3a08cc0 The rest of the documentation for manual proxy configuration for a basic
urlopen().
This is part of SF patch #523415.
2002-04-04 20:34:36 +00:00
Fred Drake d21670328c Documentation for manual proxy configuration, by Andy Gimblett.
This closes SF patch #523415.
2002-04-04 20:09:50 +00:00
Fred Drake e13602ee49 Mark the notice about the new development version of the docs as not needing
to be archived.  Most of these are pretty bland.  ;-)
2002-04-04 18:06:06 +00:00
Guido van Rossum 2e1c09c1fd Removed old Digital Creations copyright/license notices (with
permission from Paul Everitt).  Also removed a few other references to
Digital Creations and changed the remaining ones to Zope Corporation.
2002-04-04 17:52:50 +00:00
Neal Norwitz ce5df49957 SF 539024, Fix broken link to numpy 2002-04-04 14:02:45 +00:00
Fred Drake 243ea71669 Correct the descriptions of the PyObject_As*Buffer() return values.
This closes SF bug #539081.
2002-04-04 04:10:36 +00:00
Andrew M. Kuchling 3a52ff6df4 Add empty section for bool 2002-04-03 22:44:47 +00:00
Guido van Rossum 77f6a65eb0 Add the 'bool' type and its values 'False' and 'True', as described in
PEP 285.  Everything described in the PEP is here, and there is even
some documentation.  I had to fix 12 unit tests; all but one of these
were printing Boolean outcomes that changed from 0/1 to False/True.
(The exception is test_unicode.py, which did a type(x) == type(y)
style comparison.  I could've fixed that with a single line using
issubtype(x, type(y)), but instead chose to be explicit about those
places where a bool is expected.

Still to do: perhaps more documentation; change standard library
modules to return False/True from predicates.
2002-04-03 22:41:51 +00:00
Fred Drake b81fbad9c0 Updated PEP link to point to the now-canonical site. 2002-04-03 02:52:50 +00:00
Fred Drake dbfe768f66 Update the PEP URL format to point to python.org. 2002-04-03 02:47:14 +00:00
Fred Drake 103b548a76 Add a note warning against semicolons following PyObject_HEAD.
Minor cleanups.
2002-04-02 15:42:46 +00:00
Andrew M. Kuchling 45afd54c8f Add an item 2002-04-02 14:25:25 +00:00
Fred Drake aee113d368 Add an experimental mechanism to support extending the pprint formatting.
Partly responds to SF bug #505152.
2002-04-02 05:08:35 +00:00
Fred Drake 4dfb7a81c1 Explain that os.spawn*() return the process handle on Windows.
Clarify that os.waitpid() on Windows takes a process handle, not a process ID.
This closes SF bug #537582.
2002-04-01 23:30:47 +00:00
Fred Drake d764b0a484 There is no PyArg_ConvertTuple(); call it by the right name.
This closes SF bug #537511.
2002-04-01 23:12:25 +00:00
Fred Drake d5a072f2eb Fix up the documentation of the type codes to give both the C and Python
types for each code, and give the actual C types.

Clarified the support for slice operations and note when some TypeError
exceptions are raised.

This closes SF bugs 518767 and 536469.
2002-04-01 23:05:10 +00:00
Jeremy Hylton 88955cbe1f Change reference to execframes to naming. 2002-04-01 21:34:28 +00:00
Jeremy Hylton e604875b81 Restore a minimal definition of execution frame, since other parts of
the manual refer to it.

XXX Not sure that it belongs in this section, or that the concept is
particularly important for writing documentation.  Perhaps references
to the frame should be removed entirely.
2002-04-01 21:33:55 +00:00
Jeremy Hylton 1824b59e89 Update programmer's note on nested functions. 2002-04-01 21:30:15 +00:00
Jeremy Hylton f3255c8540 Reword explanation of global statement since an undeclared global is a
free variable and is subject to those rules.
2002-04-01 21:25:32 +00:00
Jeremy Hylton f0c1f1badb Note the sole case in which the ban on "from ... import *" within a
function is enforced.
2002-04-01 21:19:44 +00:00
Jeremy Hylton 15b68976da Remove the following restriction:
Names bound by import statements may not occur in global
    statements in the same scope.

Why not?
2002-04-01 21:18:02 +00:00
Jeremy Hylton d09ed68aeb Note that it is illegal to delete a cell variable.
Note that deleteing an unbound local will raise a NameError.
2002-04-01 21:15:14 +00:00
Jeremy Hylton 2225add242 Given lambda its own section, instead of burying it in boolean operators. 2002-04-01 21:05:21 +00:00
Jeremy Hylton 53ed917d3a Update / simplify Identifiers section for nested scopes.
How do I create a cross reference to section 4.1?
2002-04-01 20:52:24 +00:00
Jeremy Hylton e7d5773ed0 Update docs for nested scopes.
Replace section 4.1 with section A.3.

The new section 4.1 is titled "Naming and binding."  It includes the
text of section A.3 augmented with some of the detailed text from the
old section 4.1.

The \dfn, \index stuff is probably wrong, but I tried.

Also update other parts of appendix A to mention that nested scopes
and generators are standard features.
2002-04-01 20:38:01 +00:00
Fred Drake f54519d9e4 Update to push the docs to python.org instead of python.sf.net. 2002-04-01 20:15:05 +00:00
Andrew M. Kuchling f4dd65db1d Copy section on generators from the 2.2 document with a bit of rewriting
Add an item
2002-04-01 19:28:09 +00:00
Andrew M. Kuchling 9da3efd120 Mention 2.2.1 in intro and in bug/patch counts
Fix two typos spotted by Joonas Paalasmaa
2002-04-01 19:22:34 +00:00
Jeremy Hylton 8392f36579 Update documentation of code objects.
Split the description of co_flags into two paragraphs.  The first
describes the flags that are used for non-future purposes, where
CO_GENERATOR was added.  The second describes __future__'s use of
co_flags and mentions the only one currently meaningful,
CO_FUTURE_DIVISION.
2002-04-01 18:53:36 +00:00
Fred Drake c9319b37a5 Minor adjustments. 2002-04-01 18:49:45 +00:00
Jeremy Hylton 26c49b66bb Small fixes for description of function attributes.
func_closure is a readonly attribute.
Add \ttindex{} for func_closure.
Remove discussion of func_closure specific to 2.1.
2002-04-01 17:58:39 +00:00
Fred Drake fe5a5388c3 Use the right types for a couple of fields of the type structure. 2002-03-29 22:46:04 +00:00
Fred Drake 0ffd14c9ea Started updating information about defining attributes on types.
There's still a long way to go, but we're starting to see some real
content in the docs.
2002-03-29 22:45:28 +00:00
Fred Drake b1af6376e9 Mark a couple of types that had not been marked. 2002-03-28 23:46:41 +00:00
Fred Drake 0f9a34da2c Added comments for more entries of the type structure in the example
type implementation.
2002-03-28 23:45:22 +00:00
Fred Drake 2ab0a10913 The new files included by \verbatiminput in newtypes.tex. 2002-03-28 23:32:53 +00:00
Fred Drake 81b750d467 Move some of the longer example code to external fragments, and
include them using \verbatiminput.  This has the advantage that pages
can still break at reasonable places, and examples that go longer than
a page won't get cut off.

Make a few small markup adjustments for consistency.

Explain that PyObject_New() is not a C function but a polymorphic
beast that returns a pointer to the type that's passed as the first
arg.

Explain why type objects use the PyObject_VAR_HEAD.
2002-03-28 23:12:09 +00:00
Fred Drake e9fba9188e Added index entries. 2002-03-28 22:36:56 +00:00
Fred Drake 00f712ee24 Extend \verbatiminput so that the typeset version provides the same appearance
as a verbatim environment.  (The HTML version is already fine.)
2002-03-28 22:28:43 +00:00
Fred Drake 8d62e94761 Minor wording change. 2002-03-28 21:06:17 +00:00
Skip Montanaro bb6bbc45c0 add exception class hierarchy. This should probably be done differently,
but at least the content is there.
2002-03-28 20:53:22 +00:00
Fred Drake 31f8483eef Allow a page break in a code longish example. 2002-03-28 20:19:23 +00:00
Fred Drake 47cdf6fb6f Add documentation on the hasfree data object. 2002-03-28 19:34:53 +00:00
Fred Drake e3a3ceb2b1 Minor consistency adjustments. 2002-03-28 12:40:45 +00:00
Fred Drake 7bf9715a8b Introduce two new flag bits that can be set in a PyMethodDef method
descriptor, as used for the tp_methods slot of a type.  These new flag
bits are both optional, and mutually exclusive.  Most methods will not
use either.  These flags are used to create special method types which
exist in the same namespace as normal methods without having to use
tedious construction code to insert the new special method objects in
the type's tp_dict after PyType_Ready() has been called.

If METH_CLASS is specified, the method will represent a class method
like that returned by the classmethod() built-in.

If METH_STATIC is specified, the method will represent a static method
like that returned by the staticmethod() built-in.

These flags may not be used in the PyMethodDef table for modules since
these special method types are not meaningful in that case; a
ValueError will be raised if these flags are found in that context.
2002-03-28 05:33:33 +00:00
Fred Drake ed6a886d9f Ignore new output directory. 2002-03-27 20:37:04 +00:00
Martin v. Löwis 2e64c34850 Expose C library's gettext. Fixes #516412. 2002-03-27 18:49:02 +00:00
Skip Montanaro 8a79727b53 add seealso referring to site module doc where people can learn how to
extend sys.path using .pth files.
2002-03-27 17:29:50 +00:00
Skip Montanaro 9e38c100ab fix a typo in PyErr_Format table and add row for 'p' format char
closes bug 534495
2002-03-27 13:42:50 +00:00
Andrew M. Kuchling 03594bbb0e Fill in this document a bit, adding reminders of items that should be included 2002-03-27 02:29:48 +00:00
Fred Drake 4e526feb6a Add the "What's New" document to the index of HTML documents. 2002-03-26 20:29:11 +00:00
Fred Drake 69f0a8e42f The <link> to the stylesheet should include the type attribute. 2002-03-26 19:57:52 +00:00
Fred Drake 3014086fbf Wire up the makefile to more fully support the "What's New" documents. 2002-03-26 19:53:56 +00:00
Fred Drake 9ac14decde Wire in the "What's New" document. 2002-03-26 19:18:18 +00:00
Fred Drake 03e1031d67 Add a starter for the next "What's New" document. 2002-03-26 19:17:43 +00:00
Fred Drake 15fc72ce77 Make \url to force horizontal mode. 2002-03-26 19:14:41 +00:00
Fred Drake 57f8e06e4f Document the finditer() function and method.
This closes SF bug #520904.

Explain that many of the escapes supported by string literals are also
supported by the RE compiler, and list which ones.
This closes SF bug #529923.
2002-03-25 20:22:59 +00:00
Fred Drake 3787c9d94c Added description of binhex.Error. 2002-03-25 16:37:56 +00:00
Skip Montanaro 1e962cb61b document InvalidURL exception 2002-03-24 16:55:57 +00:00
Neil Schemenauer ccbb0edf0e Add local_hostname to SMTP.__init__(). 2002-03-24 15:41:40 +00:00
Neil Schemenauer 194152845c Fix example for PyErr_SetFromErrno() (need to pass exception type). 2002-03-23 20:57:11 +00:00
Neil Schemenauer 79f181395b Add more example exceptions that unpickling can raise. 2002-03-22 22:16:03 +00:00
Fred Drake cf43004b83 Fix broken HTML in the head; this was reported by a user as causing Opera 6.01
to crash.  The user has reported the problem to Opera, but we still should
generate something that passes for HTML.
2002-03-22 17:22:38 +00:00
Neal Norwitz e22d3dfcc1 Fix grammar 2002-03-21 12:58:54 +00:00
Walter Dörwald b25c2b0a4a [Apply SF patch #504943]
This patch makes it possible to pass Warning instances as the first
argument to warnings.warn. In this case the category argument
will be ignored. The message text used will be str(warninginstance).
2002-03-21 10:38:40 +00:00
Neal Norwitz 1abca4a515 SF# 522426, add doc for common parameter for filecmp.cmpfiles() 2002-03-20 18:55:09 +00:00
Fred Drake 1268678395 Adjust some poor wording in the text that explains what events are used
for (reported by Keith Briggs).
Wrap some very long lines.
2002-03-19 14:37:44 +00:00
Fred Drake 2f31d561d5 Clarify that copy_reg.pickle() is not intended for use with "classic" classes.
This was stated before, but a minor grammatical error made it difficult to be
sure of the meaning.
This closes SF bug #530143.
2002-03-19 03:33:33 +00:00
Fred Drake f6eafc3fe1 Fix up unescaped tilde; reported by several people. 2002-03-18 16:47:14 +00:00
Fred Drake a8b663806b Remove extra verb; reported by Detlef Lannert. 2002-03-18 16:45:01 +00:00
Martin v. Löwis 5c137c2251 Patch #495598: add an -q (quiet) option to pycompile. 2002-03-18 12:44:08 +00:00
Skip Montanaro 10acc8f9e2 added note that xmlrpclib won't marshal instances of subclasses of the
builtin types
2002-03-17 23:15:02 +00:00
Martin v. Löwis 587c98c863 Patch #430706: Persistent connections in BaseHTTPServer. 2002-03-17 18:37:22 +00:00
Fred Drake 8e0c82a35f Fix stupid typo in example. 2002-03-16 14:01:12 +00:00
Fred Drake 83d14c12a6 Markup error: braces not properly marked in dictionary display
grammer productions.
Fixes SF bug #520959.
2002-03-16 06:35:54 +00:00
Fred Drake f275803fe9 Clarify the descriptions of the positive and negative lookbehind assertions.
Added examples of positive lookbehind assertions.
This closes SF bug #529708.
2002-03-16 05:58:12 +00:00
Fred Drake 0e4cd7f267 pdfTeX 0.13 and 0.14 do not agree on the name of the macro, and I will not
change the installed version on either of the machines I use to format the
docs.  Instead, use a compatibility hack to support both versions.  This is
also better for external users of the Python styles.
2002-03-16 04:52:36 +00:00
Fred Drake 5381588073 Revise the markup related to the grammar productions to increase the
level of predictability.  This is not really "good" markup, but is arguably
better than we had before.
This closes SF bug #523117.
2002-03-15 23:21:37 +00:00
Fred Drake 7fe80a1085 Make the release status obvious in the title area. 2002-03-15 22:38:16 +00:00
Skip Montanaro dc8d40717c update text to refer to ServerProxy class in preference to Server, which is
only retained for backward compatibility with older versions of the library.
2002-03-14 17:35:25 +00:00
Fred Drake 5d117472b4 Describe how to support the iterator protocol in extension types.
This closes SF bug #420851.
2002-03-13 03:55:11 +00:00
Fred Drake e789ea19c1 Extend the list of special characters and magic markup used to produce them
to include various characters used in code samples, URLs, and other special
contexts.
This closes SF bug #525684.
2002-03-13 02:48:24 +00:00
Fred Drake f171ad9d99 Change the way \textasciitilde is implemented so it works more consistently
(dropping tildes into data that still goes through LaTeX-like processing is
a bad idea).
2002-03-13 02:44:50 +00:00
Fred Drake 6ccdccd35d Add a note that Py_None needs the same reference count treatment as any
other PyObject *.
This closes SF bug #494007.
2002-03-12 20:12:54 +00:00
Fred Drake f981617645 "level" keyword argument in example should be "stacklevel".
This closes SF bug #517684.
2002-03-12 19:49:31 +00:00
Tim Peters 8f01b680c8 Change Windows file.truncate() to (a) restore the original file position,
and (b) stop trying to prevent file growth.

Beef up the file.truncate() docs.

Change test_largefile.py to stop assuming that f.truncate() moves the
file pointer to the truncation point, and to verify instead that it leaves
the file position alone.  Remove the test for what happens when a
specified size exceeds the original file size (it's ill-defined, according
to the Single Unix Spec).
2002-03-12 03:04:44 +00:00
Fred Drake 314bae50b9 Documentation for PyObject_GetIter(), contributed by Greg Chapman
(with only minor changes by Fred).
This closes SF bug #498607.
2002-03-11 18:46:29 +00:00
Fred Drake e38b7e8fe9 Make the extension manual format using the Makefile; recent changes broke
the dependency information.
2002-03-11 18:42:08 +00:00
Tim Peters fb05db2cae file_truncate(): provide full "large file" support on Windows, by
dropping MS's inadequate _chsize() function.  This was inspired by
SF patch 498109 ("fileobject truncate support for win32"), which I
rejected.

libstdtypes.tex:  Someone who knows should update the availability
blurb.  For example, if it's available on Linux, it would be good to
say so.

test_largefile:  Uncommented the file.truncate() tests, and reworked to
do more.  The old comment about "permission errors" in the truncation
tests under Windows was almost certainly due to that the file wasn't open
for *write* access at this point, so of course MS wouldn't let you
truncate it.  I'd be appalled if a Unixish system did.

CAUTION:  Someone should run this test on Linux (etc) too.  The
truncation part was commented out before.  Note that test_largefile isn't
run by default.
2002-03-11 00:24:00 +00:00
Martin v. Löwis 27761f39a5 Patch #500136: Update Update ext build documentation. 2.2.1 candidate. 2002-03-09 10:06:14 +00:00
Fred Drake 632bda3aa0 Add more explanation of how data_files is used (esp. where the files end up
in the installation and how that location is determined).
2002-03-08 22:02:06 +00:00
Andrew M. Kuchling 10b3eac278 [Bug #486527] Note that the caller has to ensure there are no control
characters in strings being passed via XML-RPC.
Fix some typos.

2.2.1 bugfix candidate.
2002-03-08 17:46:02 +00:00
Fred Drake 02d2212c8e Add entry for mac/libscrap.tex. 2002-03-08 03:18:19 +00:00
Fred Drake f3e6f06a45 I started writing more documentation on the Scrap module at one point, but
it is difficult to do without a Mac box to try things out on.  This expands
on what was there only a little bit; hopefully someone with a Mac can work
on this as well!
2002-03-08 03:15:49 +00:00
Piers Lauder a4f8313cbb add SSL class submitted by Tino Lange 2002-03-08 01:53:24 +00:00
Fred Drake 6cb64f9e46 "Shortcut" should be "short-circuit".
This closes SF bug #526277.
2002-03-08 00:54:43 +00:00
Fred Drake da8a6dd072 Added missing version annotation for dict(). 2002-03-06 02:29:30 +00:00
Fred Drake 58fb237948 Add implementations for \textgreater and \textless, defined in (relatively)
recent versions of LaTeX2e but not support in LaTeX2HTML.
2002-03-05 04:04:06 +00:00
Fred Drake 9479c958c5 Remove extra indenatation from sample interpreter session.
Remove whitespace from the middle of an inline RE example; it was OK for
the typeset formats, but LaTeX2HTML is more touchy about this.
2002-03-05 04:02:39 +00:00
Skip Montanaro a8e1d81bdc add simple example of avoiding backtracking 2002-03-04 23:08:28 +00:00
Martin v. Löwis 29001ff234 Patch #523268, #522027: return enhanced tuples. 2002-03-01 10:47:37 +00:00
Martin v. Löwis dbd55b3737 Patch #523268, #522027: return enhanced tuples. 2002-03-01 10:38:44 +00:00
Martin v. Löwis 9986633609 Patch 520694: arraymodule.c improvements:
- make array.array a type
- add Py_UNICODE arrays
- support +=, *=
2002-03-01 10:27:01 +00:00
Michael W. Hudson 494cdb6d78 Add 2002 to PSF copyrights.
Doc/README is odd; it assigns some copyright to the PSF in 2000, when
I didn't think it existed...
2002-02-27 13:29:46 +00:00
Fred Drake b6b2aa6c75 Fix error in explanation of the interaction between $ and MULTILINE mode.
Reported by Steve Alexander.
2002-02-25 18:56:45 +00:00
Tim Peters 9f4341b3b0 SF bug #501591: dir() doc is old
Bugfix candidate.

+ Updated dir() description to match actual 2.2 behavior.

+ Replaced the dir(sys) example with dir(struct), because the former
  was way out of date and is bound to change frequently, while the
  latter is stable.

+ Added a note cautioning that dir() is supplied primarily for
  convenience at an interactive prompt (hoping to discourage its
  use as the foundation of introspective code outside the core).
2002-02-23 04:40:15 +00:00
Greg Ward f8b1f2431b Grammar tweak. 2002-02-22 21:24:32 +00:00
Fred Drake 216cbca195 Typo: thsi -> this. Closes SF bug #521450. 2002-02-22 15:40:23 +00:00
Fred Drake 8371e840d2 Correct the refcount information for the PyWeakref_GetObject() function.
This closes SF bug #520087.
2002-02-20 05:07:36 +00:00
Neal Norwitz ba902fda3c SF #515041, Update path for 2.3 2002-02-19 02:58:54 +00:00
Fred Drake e73ad2a21f Use the standard expression for the availability statement for alarm(). 2002-02-15 20:59:43 +00:00
Skip Montanaro 8d1fdafd89 note that the alarm function is not available on Windows. 2002-02-15 20:36:19 +00:00
Fred Drake 960d7a68d0 Added deprecatioon information for mac.xstat().
This closes SF bug #505150.
2002-02-15 14:35:09 +00:00
Fred Drake 928051fb26 The "%" character does not need to be escaped in verbatim environments.
This closes SF bug #517811.
2002-02-15 04:12:59 +00:00
Fred Drake 7bc6f7ac7b Consistently use \textasciicircum to produce a ^ character.
LaTeX really falls flat on this one!
2002-02-14 15:19:30 +00:00
Fred Drake c121745fda Update the instructions on reporting bugs to reflect that anonymous reports
are no longer accepted.
2002-02-04 21:43:08 +00:00
Fred Drake baf43c5036 When linking to an index page, explicitly name index.html instead of
using "./".  The later does not work nicely when browsing docs on a local
disk (as in the installed docs on Windows).
2002-02-04 21:15:42 +00:00
Fred Drake 210d3cca86 Update version number to match Include/patchlevel.h.
Make sure we clean up all the temp files craeted for the typeset formats.
2002-02-04 19:49:29 +00:00
Fred Drake 375bbc306e Update version number to match Include/patchlevel.h. 2002-02-04 19:48:25 +00:00
Tim Peters ab034fab03 Implement os.waitpid() for Windows, in a way that's compatible with Linux
where their capabilities intersect.  Would be nice if people using non-
MSVC compilers (Borland etc) took a whack at doing something similar for
them (this code relies on the MS _cwait function).
2002-02-01 11:27:43 +00:00
Skip Montanaro c318260a71 added handle_error method description 2002-01-31 17:32:24 +00:00
Tim Peters c48a3ca161 Add new constants usable with os.popen() on Windows.
NOTE:  this seems a mess wrt which symbols are available on which
platforms.  I can't fix it, but I didn't add to it <wink>, and
included an XXX comment about names claimed to be available on
Windows that aren't.  If anyone can figure out the whole ugly truth,
I'm sure a better organization will suggest itself.
2002-01-30 05:49:46 +00:00
Fred Drake c26467d53f Revise cheeseshop example so that the order of the keyword output is
completely determined by the example; dict insertion order and the string
hash algorithm no longer affect the output.
This fixes SF bug #509281.
2002-01-29 14:53:30 +00:00
Martin v. Löwis ef180dc3d0 Document that get_referrers can return unreachable but uncollected objects.
Fixes #505453.
2002-01-26 20:11:50 +00:00
Fred Drake 744f67fb62 Add keyword.kwlist to the public API. 2002-01-24 16:38:53 +00:00
Fred Drake db2d3d1b3a libkeyword.tex was missing from the list of dependencies for the
Library Reference.
2002-01-24 16:38:08 +00:00
Skip Montanaro ea3ceaa913 PyDict_Next: update doc to indicate that pkey and pvalue return values are
borrowed references.
2002-01-23 10:54:41 +00:00
Skip Montanaro a23bc42ad5 add missing return value info for PyDict_DelItem 2002-01-23 08:18:30 +00:00
Fred Drake aae728f292 Fix typo reported by François Pinard. 2002-01-21 16:09:18 +00:00
Fred Drake ac6dd0a817 Updated GNU info dir segment from Milan Zamazal. 2002-01-17 21:27:00 +00:00
Fred Drake 826e98214b Update email address. 2002-01-17 21:05:14 +00:00
Fred Drake d6bdb075ca Update the list of output formats. 2002-01-17 12:35:20 +00:00
Fred Drake ac96868d2d Consistency nits. 2002-01-17 04:51:55 +00:00
Fred Drake efff11b37c Minor consistency nit. 2002-01-17 04:44:34 +00:00
Michael W. Hudson 8fbd4a3e78 That hasn't been my email address for a while! 2002-01-16 14:55:05 +00:00
Guido van Rossum 4f3a62d9bc There's no need for typechecks on the second and third argument of
new.instancemethod() -- the instancemethod object is now a perfectly
general container.

This fixes SF bug ##503091 (Pedro Rodriquez): new.instancemethod fails
for new classes

This is a 2.2.1 candidate.
2002-01-15 19:21:05 +00:00
Thomas Heller 3d62f8ca35 Fix a simple typo. Has this to be fixed also in other branches? 2002-01-14 08:37:39 +00:00
Martin v. Löwis a55ffaeee9 Add a per-message fallback mechanism for translations. 2002-01-11 06:58:49 +00:00
Martin v. Löwis 1be6419871 Add fallback argument to translation(). Request fallbacks on install.
Fixes #500595.
2002-01-11 06:33:28 +00:00
Marc-André Lemburg 3e3eacb5fc Fixed "u#" parser marker to pass through Unicode objects as-is without
going through the buffer interface API.

Added tests for this to the _testcapi module and updated docs.
2002-01-09 16:21:27 +00:00