Fred Drake
0b9bc20e66
Add the appropriate availability annotations for the popen*() family of
...
functions -- these are not available on traditional Mac OS platforms.
Corrected the version annotations for the spawn*() functions and related
constants; these were added in Python 1.6, not 1.5.2.
2001-06-11 18:25:34 +00:00
Fred Drake
046f4d810d
Fixed parameter order for os.popen2(), os.popen3(), and os.popen(4). Added
...
a reference to these functions and popen() from the "Process Management"
section.
Based on a suggestion from comp.lang.python.
2001-06-11 15:21:48 +00:00
Fred Drake
c115835457
Fix recent changes so that this section will format again.
2001-06-11 14:55:01 +00:00
Tim Peters
7b9542a3f7
Initial support for 'q' and 'Q' struct format codes: for now, only in
...
native mode, and only when config #defines HAVE_LONG_LONG. Standard mode
will eventually treat them as 8-byte ints across all platforms, but that
likely requires a new set of routines in longobject.c first (while
sizeof(long) >= 4 is guaranteed by C, there's nothing in C we can rely
on x-platform to hold 8 bytes of int, so we'll have to roll our own;
I'm thinking of a simple pair of conversion functions, Python long
to/from sized vector of unsigned bytes; that may be useful for GMP
conversions too; std q/Q would call them with size fixed at 8).
test_struct.py: In addition to adding some native-mode 'q' and 'Q' tests,
got rid of unused code, and repaired a non-portable assumption about
native sizeof(short) (it isn't 2 on some Cray boxes).
libstruct.tex: In addition to adding a bit of 'q'/'Q' docs (more needed
later), removed an erroneous footnote about 'I' behavior.
2001-06-10 23:40:19 +00:00
Skip Montanaro
1dc98c44fe
add warning about situation where code may be executed twice, once when
...
module is __main__ and once when module is imported.
2001-06-08 14:40:28 +00:00
Fred Drake
62f9d7c021
In the section on extending the profiler, add some additional discussion
...
about setting up the dispatch table, and update the OldProfile and
HotProfile classes to the current implementations, showing the adjusted
construction for the dispatch table.
2001-06-08 05:04:19 +00:00
Martin v. Löwis
e2ccb89513
Document filter.
2001-06-07 19:01:24 +00:00
Martin v. Löwis
e24fef0dd2
Fix bug #422702 : Make flag argument to open optional, and document it that way.
2001-06-05 05:33:19 +00:00
Skip Montanaro
b9d973dac5
is -> if in rename description
2001-06-04 15:31:17 +00:00
Fred Drake
81e142b907
Document os.getenv().
...
This closes SF bug #429059 .
2001-05-31 20:27:46 +00:00
Fred Drake
c19f39272e
Some general cleanup of the threading module documentation, including
...
fixing the reference to Thread.getDeamon() (should be isDaemon()).
This closes SF bug #429070 .
2001-05-31 20:24:07 +00:00
Fred Drake
6cba3d0e64
Added entry for HTMLParser documentation.
2001-05-30 04:59:50 +00:00
Fred Drake
3b755d43ac
Michel Pelletier <michel@digicool.com>:
...
Documentation for the HTMLParser module, with small changes by FLD.
2001-05-30 04:59:00 +00:00
Fred Drake
dc9e7e42c8
readlink() description: Added note that the return value may be either
...
absolute or relative.
remove(), rename() descriptions: Give more information about the cross-
platform behavior of these functions, so single-platform developers
can be aware of the potential issues when writing portable code.
This closes SF patch #426598 .
2001-05-29 18:13:06 +00:00
Fred Drake
c80d4dd695
The parameter to the listen() method is not optional, but was marked as
...
optional in the documentation.
This closes SF bug #427985 .
2001-05-29 15:37:45 +00:00
Fred Drake
56a71eee65
Add a version annotation for splitdrive(); old, but as long as I managed
...
to end up with the information, it is better recorded than lost.
2001-05-25 16:21:00 +00:00
Fred Drake
c6d8f8d2ac
Add descriptions of {}.iteritems(), {}.iterkeys(), and {}.itervalues()
...
in the table of mapping object operations. Re-numbered the list of
notes to reflect the move of the "Added in version 2.2." note to the list
of notes instead of being inserted into the last column of the table.
2001-05-25 04:24:37 +00:00
Fred Drake
98cfab6523
One more update related to the new get() and setdefault() methods on the
...
Message object.
2001-05-22 22:00:40 +00:00
Fred Drake
6b4593e338
Update to add get() and setdefault() as supported mapping operations, and
...
add a list of the mapping methods which are not supported (per Barry's
comments).
2001-05-22 15:12:46 +00:00
Fred Drake
706314909b
Add some clarifications about the mapping interface presented by
...
rfc822.Message objects, based on comments from Barry.
2001-05-22 14:36:30 +00:00
Fred Drake
1400baa5d6
Add a "See also" section with useful links. More should be added giving
...
pointers to information about the other mailbox formats; if anyone can
provide the information needed, please let me know!
2001-05-21 21:23:01 +00:00
Fred Drake
e9719fe1a7
Fix bug in smtplib example: the prompt said to end the message with ^D,
...
but doing so raised EOFError. This makes it work as advertised and
converts to string methods where reasonable.
This closes SF bug #424776 .
2001-05-20 12:26:04 +00:00
Fred Drake
c0dac1a58c
Beef up the unicode() description a bit, based on material from AMK's
...
"What's New in Python ..." documents.
2001-05-15 15:27:53 +00:00
Fred Drake
ba7e2c8a27
Add some text to make the dircmp object section more readable, and move
...
some stuff around.
2001-05-11 17:01:32 +00:00
Fred Drake
886f113ba9
--sigh--
...
Finish the last set of changes to these files so the conversion does not
break.
2001-05-11 15:49:19 +00:00
Fred Drake
47852467f5
Markup adjustments to avoid getting junk in the index.
2001-05-11 15:46:45 +00:00
Fred Drake
96d7a70630
Replace "\begin{classdesc}{SomeClass}{\unspecified}" with
...
"\begin{classdesc*}{SomeClass}" -- the rendering of \unspecified was
identical to \moreargs, so this helps clarify things just a little.
2001-05-11 01:08:13 +00:00
Fred Drake
e7ec1efe50
Fix typo in weakref.proxy() documentation.
...
This closes SF bug #423087 .
2001-05-10 17:22:17 +00:00
Fred Drake
791c351b3d
Update example to no longer use the FCNTL module.
2001-05-10 15:57:17 +00:00
Fred Drake
e9735ac215
Remove all mentions of the strop module -- it has been pronounced Evil.
...
(The string "strop" is found in the rexec documentation, but that should
not be changed until strop is actually removed or rexec no longer allows
it.)
2001-05-10 15:05:03 +00:00
Fred Drake
d0de57cfbb
Update the fcntl module documentation.
2001-05-09 21:09:57 +00:00
Fred Drake
bda3a59a93
Itamar Shtull-Trauring <python@itamarst.org>:
...
Updates zipfile.ZipFile docs to mention the fact that you can create a
ZipFile instance from an arbitrary file-like object.
This closes patch #418011 .
2001-05-09 19:57:37 +00:00
Fred Drake
c116b82b77
Work around limitations of the module synopsis table generation to avoid
...
leaking LaTeX2HTML's internal string munging.
This fixes SF bug #420399 .
2001-05-09 15:50:17 +00:00
Fred Drake
a7c9ac6544
There is no IMAP class in the imaplib module; the class is IMAP4.
...
There is no imap module; refer to imaplib instead, since it exists.
Move the "See Also:" section in front of the sub-sections, for
consistency with other portions of the library reference.
This closes the library reference portion of SF bug #420216 .
2001-05-09 03:49:48 +00:00
Fred Drake
1ef24e1b30
Note that when inplace=1 existing backup files will be removed silently.
...
Closes SF bug #420230 .
2001-05-09 03:24:55 +00:00
Fred Drake
a6140be7b3
Michael Hudson <mwh21@cam.ac.uk>:
...
Documentation update to reflect changes to the termios module (noting
that the termios functions can take a file object as well as a file
descriptor).
This closes the documentation portion of SF patch #417081 .
2001-05-08 05:37:52 +00:00
Fred Drake
f42cc45f1b
The general iteration support is part of 2.2, not 2.1 -- fixed the version
...
annotations!
Also fixed a typo noted by Neil S.
2001-05-03 04:39:10 +00:00
Fred Drake
9cfe1824c2
Add documentation for the StopIteration exception.
2001-05-03 04:30:45 +00:00
Fred Drake
287c4cb43a
State that Mailbox objects are iterator objects.
2001-05-02 20:22:12 +00:00
Fred Drake
eacdec6b38
Update the filter() and list() descriptions to include information about
...
the support for containers and iteration.
2001-05-02 20:19:19 +00:00
Fred Drake
93656e76f9
Added section describing the iterator protocol.
2001-05-02 20:18:03 +00:00
Guido van Rossum
8b3d6ca3df
At the suggestion of Peter Funk, document 'key in dict' and 'key not
...
in dict' after has_key(), with a \versionadded{2.2} note.
2001-04-23 13:22:59 +00:00
Fred Drake
82f93c693d
Only document <file>.xreadlines() once; added version annotation.
...
This closes SF bug #417943 .
2001-04-22 01:56:51 +00:00
Fred Drake
4cacec5393
Fix a number of minor markup errors.
2001-04-21 05:56:06 +00:00
Guido van Rossum
0dbb4fba4c
Implement, test and document "key in dict" and "key not in dict".
...
I know some people don't like this -- if it's really controversial,
I'll take it out again. (If it's only Alex Martelli who doesn't like
it, that doesn't count as "real controversial" though. :-)
That's why this is a separate checkin from the iterators stuff I'm
about to check in next.
2001-04-20 16:50:40 +00:00
Fred Drake
1aec3a16f3
Add versioning notes: many of the signatures changed to allow the time
...
used to be omitted (meaning use the current time) as of Python 2.1.
Users who need cross-version portability need to know things like this.
2001-04-19 04:55:23 +00:00
Fred Drake
bc524c4e9f
Cut-&-paste-o noted by Wolfgang Teschner: decompressobj() returns
...
*DE*compression objects, not compression objects!
2001-04-18 20:16:51 +00:00
Fred Drake
895aa9da4c
Suggestion from Keith Briggs: refer to RE objects consistently instead of
...
introducing a new term ("regex") without defining it.
2001-04-18 17:26:20 +00:00
Fred Drake
293f77af6f
Add note about the version in which GetoptError was added -- this can
...
bite people interested in 1.5.2 compatibility.
2001-04-18 03:18:57 +00:00
Fred Drake
c054c75582
Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping.
2001-04-13 17:25:38 +00:00
Fred Drake
a3e56a6ceb
Minor markup adjustments.
...
Turn reference to the cmd module into a hyperlink.
2001-04-13 14:34:58 +00:00
Eric S. Raymond
4f3980d3cb
Added a test main to the pstats library that can help you browse profile dumps.
2001-04-13 00:23:01 +00:00
Fred Drake
47f11ce591
Added warning that FancyURLopener prompts the user on the terminal when
...
basic authentication is needed.
Added documentation for FancyURLopener.prompt_user_passwd(), explaining
that subclasses should provide more appropriate behavior for the hosting
environment.
2001-04-12 20:26:49 +00:00
Fred Drake
62a26699c4
Added module synopsis for the chapter summary.
...
Added documentation for TestCase.assertRaises().
Added text for "Mapping concepts to classes", and merged it into the
front matter instead of separating it into a new section.
Removed use of "assert" in examples.
Update the descriptions to reflect further changes from discussions on
the pyunit-interest list.
Added documentation for the defaultTestLoader object and the
TestLoader methods.
Added the assert*() names for the TestCase helper methods.
2001-04-12 19:34:38 +00:00
Fred Drake
e20bd19f86
Convert several \seetext references to \seerfc and \seetitle versions.
...
These format somewhat better and include more semantic information in the
source.
2001-04-12 16:47:17 +00:00
Fred Drake
0056a427bb
Added a lot of text from Steve Purcell's HTML documentation.
...
Updated reference material substantially based on discussions on the
pyunit-interest mailing list (not all changes are in the code in CVS
yet).
2001-04-12 04:50:06 +00:00
Fred Drake
b942c2f788
Fixed bug in example.
...
This closes SF bug #415522 .
Also fix markup error in text following the example.
2001-04-11 21:33:47 +00:00
Barry Warsaw
c3cbbaf513
Added some additional documentation describing how BabylMailbox
...
actually works (it returns a message containing the visible headers,
not the original headers). Doc change approved by Fred; closes SF bug
#412230 .
2001-04-11 20:12:33 +00:00
Fred Drake
eedf985056
Include a synopsis for the chapter overview.
2001-04-11 19:17:11 +00:00
Moshe Zadka
2bd0d88360
Fixing bug 405999 -- clarifying differences between Python's
...
getopt and GNU getopt -- Python is like classical UNIX getopt.
2001-04-11 07:33:08 +00:00
Fred Drake
29be70195a
Added definition of "test fixture".
...
Added description of optional parameter to the TestSuite constructor.
Added descriptions of the TestLoader and TextTestRunner classes.
Added method descriptions for the TestCase class.
2001-04-10 22:25:06 +00:00
Fred Drake
ac154a17a3
Remove the mapping() function from the documentation.
...
Add a description of the ReferenceError exception.
2001-04-10 19:57:58 +00:00
Fred Drake
da00cda9fa
Add note that difflib was added in Python 2.1.
2001-04-10 19:56:09 +00:00
Fred Drake
cfac6d23fd
Normalize tabs to spaces.
...
Update the attribution for the "Curses Programming with Python" How-To.
Change the way the reference to the Demo/curses/ directory is marked up.
2001-04-10 18:49:09 +00:00
Fred Drake
6fda3ac474
Add reference to the DDJ article discussing a similar algorithm.
2001-04-10 18:41:16 +00:00
Fred Drake
90a72f8dcd
Add documentation for getmoduleinfo() and getmodulename().
2001-04-10 15:12:34 +00:00
Fred Drake
819815abea
Fix typo in example (\b should be \n in string literal).
...
This closes SF bug #414279 .
2001-04-09 15:57:06 +00:00
Fred Drake
9c846366ee
Fix a number of bugs and omissions in the AddressList documentation, most
...
noted by Steve Holden.
This closes SF bug #413876 .
2001-04-09 15:42:56 +00:00
Fred Drake
501d90471d
Add entry for unittest documentation.
2001-04-07 05:42:14 +00:00
Fred Drake
b9ad228798
Start of documentation for the unittest module. Some of this comes from
...
Steve Purcell's documentation, and a lot of it is written based on
using PyUnit and reading the implementation.
There is more to come, but I want to get this check in before I have a
disk crash or anything else bad happens.
2001-04-07 05:41:39 +00:00
Fred Drake
4cf1227e56
Change {\em ...} to \emph{...} for consistency with the rest of the Python
...
documentation.
2001-04-05 18:31:27 +00:00
Fred Drake
f459d852e5
Add some information about what to expect of the DocumentType's
...
.internalSubset attribute based on a clarification from the www-dom
list.
2001-04-05 18:30:04 +00:00
Fred Drake
659f377ed9
Add entry for curses.panel documentation.
2001-03-29 22:23:19 +00:00
Fred Drake
14631f674f
Fix serious markup errors.
2001-03-29 22:22:23 +00:00
Fred Drake
cb83988151
Added example use of weak references, contributed by Tim Peters.
2001-03-28 21:15:41 +00:00
Fred Drake
21e036ccca
Add a note that the "kfm" controller supports "konqueror" as well as the
...
old KDE 1 "kfm" command.
2001-03-26 16:17:21 +00:00
Guido van Rossum
c8da0f966f
Document use_rawinput. (Although now that I think more about it, a
...
better solution would have been to factor out the raw_input() call and
make it into an overridable method. Oh well, maybe later...)
2001-03-24 19:17:35 +00:00
Jeremy Hylton
aa90adcfb9
Add nested scopes spec to appendix.
...
Add new opcodes LOAD_CLOSURE, LOAD_DEREF, STORE_DEREF, MAKE_CLOSURE to
docs for dis module.
Add docs for new function and code members in Sec. 3 of ref manual.
They're present regardless of whether nested scopes are used.
Remove description of default argument hack from Sec. 7 of the ref
manual and refer the reader to the appendix.
2001-03-23 17:23:50 +00:00
Ka-Ping Yee
ce7298ab42
Explain the difference between NL and NEWLINE.
2001-03-23 05:22:12 +00:00
Ka-Ping Yee
c608fb6389
Give a slightly better explanation of excepthook.
2001-03-23 05:17:41 +00:00
Fred Drake
5e0dfaccd1
Update to the most recent weakref changes.
2001-03-23 04:36:02 +00:00
Ka-Ping Yee
b5c5132d1a
Add sys.excepthook.
...
Update docstring and library reference section on 'sys' module.
New API PyErr_Display, just for displaying errors, called by excepthook.
Uncaught exceptions now call sys.excepthook; if that fails, we fall back
to calling PyErr_Display directly.
Also comes with sys.__excepthook__ and sys.__displayhook__.
2001-03-23 02:46:52 +00:00
Fred Drake
4e6d09e369
Moved the description of the tzparse module to the "Obsolete" section
...
and note that it fails when the TZ environment variable is not set.
This closes SF bug #409683 .
2001-03-20 23:13:53 +00:00
Fred Drake
b15bbc8d3d
Add documentation for SGMLParser.handle_decl().
2001-03-16 20:39:41 +00:00
Fred Drake
f0ebbe0bd0
Re-order some method descriptions for a more logical grouping.
...
(Based on reader comment!)
2001-03-08 22:46:41 +00:00
Fred Drake
990b0fec1a
Update documentation to reflect the shift to NetrcParseError instead of
...
SyntaxError.
2001-03-06 06:55:18 +00:00
Fred Drake
93c867139f
Lots of organizational changes for consistency with the rest of the
...
documentation.
Fix a few small markup nits.
2001-03-02 20:39:34 +00:00
Fred Drake
043d5e5514
For copyfile(), be explicit that src and dst are file names; that was only
...
implied.
2001-03-02 16:46:42 +00:00
Fred Drake
7606e4d00e
Added entry for urllib2 documentation.
2001-03-01 19:54:29 +00:00
Guido van Rossum
f89ad5ed6b
Document configuration flags to compile for large file support on
...
certain Linux systems.
2001-03-01 18:29:57 +00:00
Moshe Zadka
8a18e99008
Checking in patch 404826 -- urllib2 enhancements and documentations.
...
(please not that the library reference does *not* include the
urllib2 documnetation -- that will wiat for Fred)
2001-03-01 08:40:42 +00:00
Guido van Rossum
56ba72a563
Document warn_explicit().
2001-02-28 23:34:21 +00:00
Fred Drake
7840a9cb99
Add entry for the inspect module.
2001-02-28 23:02:20 +00:00
Fred Drake
6dbd382ec8
Clean up some of the markup for consistency, wrap some long lines.
2001-02-28 23:01:38 +00:00
Skip Montanaro
58177b9975
added description of NL token
2001-02-28 22:05:41 +00:00
Fred Drake
969ab2710a
Update documentation for termios module; do not refer to the TERMIOS module
...
for constant definitions.
Add a deprecation to the TERMIOS module.
2001-02-27 22:01:15 +00:00
Martin v. Löwis
5e1633365d
Patch #403985 : Add support for weak-keyed dictionaries
2001-02-27 18:36:56 +00:00
Ka-Ping Yee
6397c7c9a9
inspect: a module for getting information out of live Python objects
2001-02-27 14:43:21 +00:00
Barry Warsaw
d4614e8371
Updates to the semantics of function and method attributes.
2001-02-27 03:32:35 +00:00
Fred Drake
07e6c505ad
Minor adjustments, including markup corrections.
2001-02-23 19:15:56 +00:00