Commit Graph

3200 Commits

Author SHA1 Message Date
Fred Drake 2e3ae21060 Fix some nits Guido brought up last August:
- give subsection pages nicer names
- shorten some really long table cells; table cells can't wrap in the
  typeset version of the documentation
2003-01-06 15:50:32 +00:00
Fred Drake 2b0a3d33f8 Fix markup so this will format again. 2003-01-06 15:03:11 +00:00
Raymond Hettinger 9f5b07dd92 SF bug #592859: os.chmod is underdocumented
Document constants for permission bits.
2003-01-06 13:31:26 +00:00
Neal Norwitz b9ef4aea5e SF #651082, tarfile module implementation from Lars Gustäbel 2003-01-05 23:19:43 +00:00
Neal Norwitz 6d23b170cf Fix a typo 2003-01-05 22:20:51 +00:00
Tim Peters 75a6e3bd1a datetime_from_timet_and_us(): ignore leap seconds if the platform
localtime()/gmtime() insists on delivering them, + associated doc
changes.

Redid the docs for datetimtez.astimezone().
2003-01-04 18:17:36 +00:00
Tim Peters adf642038e A new implementation of astimezone() that does what we agreed on in all
cases, plus even tougher tests of that.  This implementation follows
the correctness proof very closely, and should also be quicker (yes,
I wrote the proof before the code, and the code proves the proof <wink>).
2003-01-04 06:03:15 +00:00
Raymond Hettinger 69bf8f3f4e SF bug #655271: Slightly modify locals() doc
Clarify the operation of locals().
2003-01-04 02:16:22 +00:00
Raymond Hettinger 2ca243368f SF bug #651149: Review libshelve.tex when possible
Minor fixes to markup, spelling, parameter names, and abbreviations.
2003-01-04 01:53:38 +00:00
Tim Peters 8827d0c338 Replaced the flawed "local time" example tzinfo class with the guts
of Guido's later Local.py (from the datetime sandbox).
2003-01-03 22:26:57 +00:00
Tim Peters 397301eccb The tzinfo methods utcoffset() and dst() must return a timedelta object
(or None) now.  In 2.3a1 they could also return an int or long, but that
was an unhelpfully redundant leftover from an earlier version wherein
they couldn't return a timedelta.  TOOWTDI.
2003-01-02 21:28:08 +00:00
Skip Montanaro 4abd5f0fce Allow list sort's comparison function to explicitly be None. See SF patch
661092.
2003-01-02 20:51:08 +00:00
Tim Peters 710fb1548a astimezone() internals: if utcoffset() returns a duration, complain if
dst() returns None (instead of treating that as 0).
2003-01-02 19:35:54 +00:00
Neal Norwitz e149798c7f Add some version info for new methods and class 2003-01-02 15:32:00 +00:00
Fred Drake 74bcac4cae - documented Ellipsis, NotImplemented
- minor markup changes
- indented for consistency with newer content
2003-01-02 05:13:51 +00:00
Fred Drake 45e482fd3d Document that apply() is deprecated. See:
http://mail.python.org/pipermail/python-dev/2003-January/031556.html
2003-01-02 04:54:04 +00:00
Tim Peters f36151556f A quicker astimezone() implementation, rehabilitating an earlier
suggestion from Guido, along with a formal correctness proof of the
trickiest bit.  The intricacy of the proof reveals how delicate this
is, but also how robust the conclusion:  correctness doesn't rely on
dst() returning +- one hour (not all real time zones do!), it only
relies on:

1. That dst() returns a (any) non-zero value if and only if daylight
   time is in effect.

and

2. That the tzinfo subclass implements a consistent notion of time zone.

The meaning of "consistent" was a hidden assumption, which is now an
explicit requirement in the docs.  Alas, it's an unverifiable (by the
datetime implementation) requirement, but so it goes.
2003-01-01 21:51:37 +00:00
Skip Montanaro 0233bd9c7d mention built-in constants. 2003-01-01 20:37:14 +00:00
Skip Montanaro 1f041e7aa8 process libconsts.tex 2003-01-01 20:34:00 +00:00
Skip Montanaro 17804b1df4 new section - builtin constants 2003-01-01 20:33:38 +00:00
Fred Drake 0f8e543159 - use classdesc where we can (for better indexing)
- more style consistency crud
2002-12-31 18:31:48 +00:00
Fred Drake 436eadd455 General style conformance. Markup some unmarked constructs. 2002-12-31 18:13:11 +00:00
Raymond Hettinger f621232c0d Use funcdesc instead of classdesc to be consistent with out sections. 2002-12-31 17:24:50 +00:00
Fred Drake e2c649126e Further cleanup of exceptions. All interpolation-related exceptions
now derive from InterpolationError, which is not raised directly (only
subclasses get raised).  This matches what the docs already said.
2002-12-31 17:23:27 +00:00
Raymond Hettinger 6222958500 Spelling fix 2002-12-31 16:37:03 +00:00
Raymond Hettinger cbd6cd2312 Add markup for time object.
Cleanup whitespace.
Fix unbalanced parenthesis.
2002-12-31 16:30:49 +00:00
Tim Peters 9532298c82 Removed the now-untrue (or soon-to-be untrue) part of the astimezone()
docs.  Replaced it with an XXX block, because the hoped-for treatment
of DST endcases remains unclear (Guido doesn't really like raising an
exception when it's impossible to deliver a correct result, but so
far I have no way in hand to consistently deliver a defined incorrect
result either).
2002-12-31 16:01:47 +00:00
Eric S. Raymond 2852cbaf26 Document the new ,netrc awareness in nntplib. 2002-12-31 15:28:44 +00:00
Fred Drake f91b4619e0 Barry raised reasonable objections to the macro name \mimeheader, so
we'll simply revert to \mailheader since there's no other good name.
2002-12-31 15:23:09 +00:00
Fred Drake f14730a49a - correct the deprecation markups so this formats again
- some minor cleanups
2002-12-31 15:10:49 +00:00
Raymond Hettinger c5f5f87f74 Complete the markup for timedelta objects.
Fix a curly brace that should have been a paren.
2002-12-31 14:26:54 +00:00
Neal Norwitz f3edea5b90 Use the name (path) specified in the parameter list 2002-12-31 13:38:28 +00:00
Martin v. Löwis 96a60e4af5 Patch #658927: Add getctime to os.path.
Document that getatime and getmtime may return floats.
2002-12-31 13:11:54 +00:00
Martin v. Löwis 5c37a7717d Document standard encodings. 2002-12-31 12:39:07 +00:00
Neal Norwitz ee711092eb SmartCookie and SerialCookie were recently deprecated 2002-12-31 12:27:11 +00:00
Neal Norwitz 99448e5214 InterpolationSyntaxError was added in 2.3 2002-12-31 12:23:10 +00:00
Guido van Rossum 2714706188 Phrase repair. 2002-12-31 04:41:38 +00:00
Guido van Rossum 8e7ec7cec8 Minor markup and spelling repair. 2002-12-31 04:39:05 +00:00
Fred Drake 81e4aa7054 - re-mark ESR's warning about extended registry syntax
- document InterpolationSyntaxError
2002-12-30 23:50:19 +00:00
Fred Drake 740f80029c - fix use of \refmodule markup
- correct some module names, add hyperlinks
- wrap some long lines
2002-12-30 23:00:36 +00:00
Guido van Rossum 2969233f9a Add dummy_thread[ing] sections and reference these from libthread[ing]. 2002-12-30 22:34:10 +00:00
Guido van Rossum ad50ca91a9 Brett Cannon's dummy_thread and dummy_threading modules (SF patch
622537), with some nitpicking editorial changes.
2002-12-30 22:30:22 +00:00
Fred Drake a37e5cce4b We're using strictly American spellings, so there's no diaresis over
the i in naive.

More markup fixups.
2002-12-30 21:26:42 +00:00
Tim Peters bad8ff089a A step on the way to making tzinfo classes writable by mortals: get rid
of the timetz case.  A tzinfo method will always see a datetimetz arg,
or None, now.  In the former case, it's still possible that it will get
a datetimetz argument belonging to a different timezone.  That will get
fixed next.
2002-12-30 20:52:32 +00:00
Fred Drake 9bdeee492a Clean up a table so it passes formatting. 2002-12-30 20:35:32 +00:00
Raymond Hettinger 0de926fd12 Added the \var{} markup so the tables will look good. 2002-12-30 20:21:21 +00:00
Raymond Hettinger 6005a344ce Added markup upto line 233. 2002-12-30 20:01:24 +00:00
Barry Warsaw d1adc8a6af Describe the new `errors' argument to Header.__init__() and
Header.append()
2002-12-30 19:17:37 +00:00
Andrew M. Kuchling fa91858c6c More markup additions 2002-12-30 14:20:16 +00:00
Andrew M. Kuchling d6d7cfaada Minor grammar fix, and clarification 2002-12-30 03:08:27 +00:00
Andrew M. Kuchling c97868ee2f Mark up more text 2002-12-30 03:06:45 +00:00
Raymond Hettinger 40f6217092 SF patch 658251: Install a C implementation of the Mersenne Twister as the
core generator for random.py.
2002-12-29 23:03:38 +00:00
Raymond Hettinger c7b076928c Incorporate Skip's suggestion to use SciPy's validation test near
equality.  Note, there is another flavor that compares to a given
number of significant digits rather than decimal places.  If there
is a demand, that could be added at a later date.
2002-12-29 17:59:24 +00:00
Raymond Hettinger f8bcfb13f1 SF Bug 645777: list.extend() works with any iterable and is no longer
experimental.
2002-12-29 05:49:09 +00:00
Tim Peters 276a8f3b80 astimezone(): document that None is an OK argument. 2002-12-27 21:41:32 +00:00
Eric S. Raymond 56b3184e89 Added a useful warning to the documentation. 2002-12-27 20:05:36 +00:00
Martin v. Löwis 33e94437ca Document killpg. 2002-12-27 10:21:19 +00:00
Martin v. Löwis 438b534ad0 Patch #657889: Implement posix.getloadavg. 2002-12-27 10:16:42 +00:00
Tim Peters 60c76e4016 Make comparison and subtraction of aware objects ignore tzinfo if the
operands have identical tzinfo members (meaning object identity -- "is").
I misunderstood the intent here, reading wrong conclusion into
conflicting clues.
2002-12-27 00:41:11 +00:00
Just van Rossum 8982595870 Backing out patch #642578 in anticipation of final acceptance of PEP 302. 2002-12-25 23:13:34 +00:00
Raymond Hettinger e11b510a5b SF 658405: calendar.py to rely on the datetime module instead of the time
module.

The code is shorter, more readable, faster, and dramatically increases the
range of acceptable dates.

Also, used the floor division operator in leapdays().
2002-12-25 16:37:19 +00:00
Tim Peters 80475bb4d2 Implemented datetime.astimezone() and datetimetz.astimezone(). 2002-12-25 07:40:55 +00:00
Tim Peters 52d134874f Removed blurb admonishing users to raise an exception if the datetime
argument to a tzinfo method doesn't have a matching tzinfo member.
2002-12-24 16:34:13 +00:00
Tim Peters 2483b61e03 Added note about technical pickle limitation on tzinfo instances. 2002-12-24 16:30:58 +00:00
Tim Peters 1cff9fc97c tzinfo.{utcoffset,dst} can return timedelta (or integer or None).
{timetz,datetimetz}.{uctcoffset,dst} do return timedelta (or None).
2002-12-24 16:25:29 +00:00
Tim Peters 12bf339aea Implemented .replace() methods for date, datetime, datetimetz, time and
timetz.
2002-12-24 05:41:27 +00:00
Tim Peters 29fb9c7e07 Brought the strftime explanation into synch with the plain-text sandbox
docs, and moved its section to the end (before the "C API" section,
which latter doesn't really belong in the Library manual).
2002-12-23 22:21:52 +00:00
Fred Drake 446f32367b Add in the datetime docs now that they pass LaTeX. Still ugly, but that can
be fixed.
2002-12-23 19:03:00 +00:00
Fred Drake bbdb250862 Lots of markup changes. This is still pretty sad, but passes LaTeX
and is mostly readable.
2002-12-23 18:58:06 +00:00
Fred Drake ce5200842e Move the examples of concrete tzinfo classes to a separate file, so the
verbatim environment does not bollux page breaking.
2002-12-23 18:52:19 +00:00
Fred Drake 4a80a3ec21 Added docs for (draft) pkgutil module. 2002-12-23 16:53:59 +00:00
Tim Peters 8ed8320827 Fixed longstanding bug in the description of strftime's %W code. 2002-12-20 17:15:39 +00:00
Andrew M. Kuchling ca2623a2f9 Check in current, unfinished, draft of datetime docs
(Fred, don't bother to add to lib.tex or to proofread this yet.)
2002-12-18 14:59:11 +00:00
Fred Drake e0f02f0826 Fix some small markup nits. 2002-12-18 02:07:14 +00:00
Neal Norwitz 3e93b4d222 Fix typo spotted by Richie Hindle 2002-12-18 01:20:29 +00:00
Michael W. Hudson cfd3884882 This is Richie Hindle's patch
[ 643835 ] Set Next Statement for Python debuggers

with a few tweaks by me: adding an unsigned or two, mentioning that
not all jumps are allowed in the doc for pdb, adding a NEWS item and
a note to whatsnew, and AuCTeX doing something cosmetic to libpdb.tex.
2002-12-17 16:15:34 +00:00
Neal Norwitz 212b43f90c Add markup for base parameter 2002-12-17 01:24:11 +00:00
Neal Norwitz 046b8a7244 Fix SF # 641111, Undocumented side effect of eval
Try to clear up confusion about the current globals being copied
into a globals dict passed to eval().  This wording (more or less)
was suggested in bug report.  It should probably be made clearer.

Backport candidate.
2002-12-17 01:08:06 +00:00
Neal Norwitz e9ce25e512 Fix SF #642742, property() builtin not documented
Added doc for functions new to 2.2:  classmethod property staticmethod super
Taken from docstrings.  Could use review.
Hope there wasn't a reason why these shouldn't have been added.

Backport candidate.
2002-12-17 01:02:57 +00:00
Gustavo Niemeyer 786ddb29c9 Fixed bug
[#521782] unreliable file.read() error handling

* Objects/fileobject.c
  (file_read): Clear errors before leaving the loop in all situations,
  and also check if some data was read before exiting the loop with an
  EWOULDBLOCK exception.

* Doc/lib/libstdtypes.tex
* Objects/fileobject.c
  Document that sometimes a read() operation can return less data than
  what the user asked, if running in non-blocking mode.

* Misc/NEWS
  Document the fix.
2002-12-16 18:12:53 +00:00
Just van Rossum edd179ee77 typo fix. 2002-12-15 13:14:22 +00:00
Raymond Hettinger 866964c3a3 Apply SF patch 652930: Add optional base argument to math.log(x[, base]). 2002-12-14 19:51:34 +00:00
Walter Dörwald d9a6ad3beb Enhance issubclass() and PyObject_IsSubclass() so that a tuple is
supported as the second argument. This has the same meaning as
for isinstance(), i.e. issubclass(X, (A, B)) is equivalent
to issubclass(X, A) or issubclass(X, B). Compared to isinstance(),
this patch does not search the tuple recursively for classes, i.e.
any entry in the tuple that is not a class, will result in a
TypeError.

This closes SF patch #649608.
2002-12-12 16:41:44 +00:00
Just van Rossum b083cb3901 Patch #651621, approved by MvL.
This patch allows ZipFile.writestr() to be called with
an archive file name instead of a ZipInfo instance:

z = ZipFile("myarchive.zip", "w")
z.writestr("foo/baz/file.ext", data)
z.close()

I found the old writestr() method very inconvenient
for simple (but common) things.

If called with a file name instead of a ZipInfo
instance, the date_time is set to the current date/time,
which makes sense to me for anonymous data.
2002-12-12 12:23:32 +00:00
Martin v. Löwis 0479104a91 Patch #651006: Better explain what component might be empty. 2002-12-11 12:55:53 +00:00
Raymond Hettinger d2bef8256b Update comments about the performance of xrange(). 2002-12-11 07:14:03 +00:00
Skip Montanaro 3bf99e3e87 Add support for binary pickles to the shelve module. In some situations
this can result in significantly smaller files.  All classes as well as the
open function now accept an optional binary parameter, which defaults to
False for backward compatibility.  Added a small test suite, updated the
libref documentation (including documenting the exported classes and fixing
a few other nits) and added a note about the change to Misc/NEWS.
2002-12-08 18:36:24 +00:00
Fred Drake edb635ff5c Remove extra ")" in example. 2002-12-06 18:52:28 +00:00
Fred Drake 08d10f985e Typo: "dead lock" --> "deadlock" 2002-12-06 16:45:05 +00:00
Fred Drake a41b2bb981 Fix problem in example code. It's minor in this particular example,
but can lead to mysterious problems in real applications.
2002-12-03 22:57:37 +00:00
Fred Drake 7af24bd237 Fix example regular expressions that simulate scanf() constructs. 2002-12-03 18:49:17 +00:00
Martin v. Löwis 71aa6d6db9 Patch #646824: Remove extra \end. 2002-12-03 18:09:02 +00:00
Just van Rossum 3eb166b49b Slightly improved version of patch #642578: "Expose PyImport_FrozenModules
in imp". This adds two functions to the imp module: get_frozenmodules()
and set_frozenmodules().
2002-11-29 20:47:40 +00:00
Raymond Hettinger e33d3df030 SF Patch 643443. Added dict.fromkeys(iterable, value=None), a class
method for constructing new dictionaries from sequences of keys.
2002-11-27 07:29:33 +00:00
Fred Drake e9cfcef71e Clarify the interpretation of the __getstate__() return value for
new-style classes.
Closes SF bug #637941.
2002-11-27 05:26:46 +00:00
Gustavo Niemeyer 057ab14e7d * libbz2.tex
Fixed minor typo, suggested by Drew Perttula <drewp@bigasterisk.com>.
2002-11-25 18:51:43 +00:00
Andrew M. Kuchling 15353f5c64 Remove extra word 2002-11-25 16:01:08 +00:00
Martin v. Löwis b5c980b802 Add unidata_version. Bump generator version number. 2002-11-25 09:13:37 +00:00
Martin v. Löwis 677bde2dd1 Patch #626485: Support Unicode normalization. 2002-11-23 22:08:15 +00:00
Fred Drake 6e596b6895 Added change note about returning a dictionary based on keyword
arguments.
2002-11-23 15:02:13 +00:00
Just van Rossum a797d8150d Patch #642500 with slight modifications: allow keyword arguments in
dict() constructor. Example:
  >>> dict(a=1, b=2)
  {'a': 1, 'b': 2}
  >>>
2002-11-23 09:45:04 +00:00
Fred Drake a191befb2d Clarify the default setting for daemon_threads. 2002-11-22 14:29:42 +00:00
Fred Drake 74f5a56c2c Fix markup. 2002-11-22 14:28:53 +00:00
Martin v. Löwis 4581cfa326 Patch #486438: Make module argument to testmod optional. 2002-11-22 08:23:09 +00:00
Martin v. Löwis f86e8ef33e Patch #550765: Add daemon_threads flag. 2002-11-22 08:08:44 +00:00
Piers Lauder d3c821ee71 added details of new IMAP4_stream class; emphasised meaning of data part of command results; added proxyauth command description 2002-11-22 05:47:39 +00:00
Martin v. Löwis d899605e30 Patch #633547: Support plural forms. Do TODOs in test suite. 2002-11-21 21:45:32 +00:00
Tim Peters 3350b5bfd9 NamedTemporaryFile: clarify behavior based on confusions noted by a
user, and spell out a x-platform use limitation.
2002-11-21 16:32:11 +00:00
Walter Dörwald 72f861657a Document additional error handling names available through PEP 293. 2002-11-19 21:51:35 +00:00
Walter Dörwald f171540ab8 Change int() so that passing a string, unicode, float or long argument
that is outside the integer range no longer raises OverflowError, but
returns a long object instead.

This fixes SF bug http://www.python.org/sf/635115
2002-11-19 20:49:15 +00:00
Raymond Hettinger 311f419628 Improve comments. Clarify docs.
Replace "type(0)" with "int".
Replace "while 1" with "while True"
2002-11-18 09:01:24 +00:00
Raymond Hettinger 8ddc176e2e Improve DictMixin.
Replaced docstring with comments.  Prevents subclass contamination.
Added the missing __cmp__() method and a test for __cmp__().
Used try/except style in preference to has_key() followed by a look-up.
Used iteritem() where possible to save creating a long key list and
   to save redundant lookups.
Expanded .update() to look for the most helpful methods first and gradually
   work down to a mininum expected interface.
Expanded documentation to be more clear on how to use the class.
2002-11-18 04:34:10 +00:00
Skip Montanaro 6141812820 correct typo detected by Lee Hansen 2002-11-17 11:09:50 +00:00
Fred Drake e55bec2566 Better note that str.zfill() was added in 2.2.2 as well. ;-( 2002-11-16 00:44:00 +00:00
Fred Drake 9171801de9 Document that a minor feature was added in 2.2.2. ;-(
Closes SF bug #639170.
2002-11-16 00:41:55 +00:00
Neal Norwitz 5654cc215a SF 639138, Ref. calendar module in time docs by John J Lee
Will backport.
2002-11-15 23:00:30 +00:00
Fred Drake c734b01759 Fix critical markup errors. 2002-11-15 18:49:57 +00:00
Fred Drake 3a2cda876b Minor revisions to clarify the status of xreadlines(), change the way
iteration support was documented; the docs for __iter__() were just
confusing.
2002-11-15 16:38:06 +00:00
Raymond Hettinger 7994716b6b SF patch #520382: Expand shelve.py to have a full dictionary interface
and add a mixin to UserDict.py to make it easier to implement a full
dictionary interface.
2002-11-15 06:46:14 +00:00
Skip Montanaro 4ebe2e3914 add liblogging 2002-11-14 03:58:20 +00:00
Skip Montanaro 649698f72e initial rough cut at documentation of logging module. This is basically
just a conversion of pydoc.help(logging).
2002-11-14 03:57:19 +00:00
Fred Drake bad460790e Document struct_time and the field names. 2002-11-13 19:05:01 +00:00
Fred Drake a5a173efbf Fix broken markup.
Closes SF bug #637807.
2002-11-13 17:48:15 +00:00
Fred Drake 2c184e7eea Typo: it's --> its
Closes SF bug #637810.
2002-11-13 15:56:13 +00:00
Fred Drake 3d03968c75 Clarified meaning of \w and \W with respect to the UNICODE and LOCALE flags.
Closes SF bug #635595.
2002-11-12 23:12:54 +00:00
Tim Peters b9099c3df4 SF patch 637176: list.sort crasher
Armin Rigo's Draconian but effective fix for

SF bug 453523: list.sort crasher

slightly fiddled to catch more cases of list mutation.  The dreaded
internal "immutable list type" is gone!  OTOH, if you look at a list
*while* it's being sorted now, it will appear to be empty.  Better
than a core dump.
2002-11-12 22:08:10 +00:00
Fred Drake 4b9ed2f346 Clarified documentation of tempnam().
Closes SF bug #635656.
2002-11-12 22:07:11 +00:00
Raymond Hettinger f24eb35d18 SF patch 629637: Add sample(population, k) method to the random module.
Used for random sampling without replacement.
2002-11-12 17:41:57 +00:00
Walter Dörwald 430b1563dd Add documentation for the PEP 293 functionality:
The errors attribute can be changed after the reader/writer
is created.

For encoding there are two additional errors values:
"xmlcharrefreplace" and "backslashreplace".

These values can be extended via register_error().
2002-11-07 22:33:17 +00:00
Fred Drake b5f41dedeb Minor markup adjustments. 2002-11-07 17:13:03 +00:00
Thomas Heller 5b470e0a3a Document the changed fdopen behaviour.
(Hope the markup is ok).
2002-11-07 16:33:44 +00:00
Andrew M. Kuchling e3fb22bd4a [Patch #633635 from David M. Cooke]
Make docs accurate; getch() in nodelay mode returns -1
2002-11-06 14:17:21 +00:00
Neal Norwitz 110aa50cc2 Fix minor wording and 2 typos 2002-11-05 23:55:27 +00:00
Neal Norwitz fad265e651 Whoops, fix the typo correctly this time 2002-11-05 22:46:39 +00:00
Barry Warsaw 75f36b7040 Document the new `pp' command. 2002-11-05 22:41:16 +00:00
Neal Norwitz c2f7757ef5 Fix minor typos 2002-11-05 22:37:58 +00:00
Martin v. Löwis a288a234ec Document that images go away when they go away. Fixes #632323. 2002-11-05 22:11:50 +00:00
Fred Drake 18c7d98bd1 Fix a few minor nits. Still need to actually proofread this. 2002-11-05 17:54:02 +00:00
Gustavo Niemeyer f8ca8364c9 Patch implementing bz2 module.
* setup.py
  (PyBuildExt.detect_modules): Included bz2 module detection.

* Modules/bz2module.c
* Lib/test/test_bz2.py
* Doc/lib/libbz2.tex
  Included files implementing, testing, and documenting bz2 module.

* Doc/Makefile.deps
* Doc/lib/lib.tex
  Include references to libbz2.tex.

* Misc/NEWS
  (Library): Mention distutils' c++ linkage patch, and new bz2 module.
2002-11-05 16:50:05 +00:00
Martin v. Löwis 22610da481 Document symbolic constants for commands. 2002-11-04 17:41:18 +00:00
Martin v. Löwis 1da9c57c74 Patch #630829: Don't block on IAC, process suboptions. 2002-11-04 09:56:00 +00:00
Martin v. Löwis f0a4668e6f Add getpreferredencoding. Support @euro modifiers. Fixes #554676.
The @euro part is backported to 2.2.3.
2002-11-03 17:20:12 +00:00
Neal Norwitz cf57e50989 Fix SF #632864, Typo string instead of sting in LibDoc. Will backport. 2002-11-03 13:13:20 +00:00
Neal Norwitz 034c749ff4 Fix SF #618146, overflow error in calendar module
Will backport.
2002-11-03 00:13:42 +00:00
Walter Dörwald 1a7a894d90 Move introductory sentence to where it belongs. 2002-11-02 13:32:07 +00:00
Fred Drake 9482d2591a Update example for the type() function to use the currently accepted
preference of using "is" instead of "==" to compare types, use
built-in names where available, and point to the isinstance()
function.
Closes SF bug #632196.
2002-11-01 21:33:44 +00:00
Andrew M. Kuchling 3adefccdcb Use personal e-mail address 2002-10-30 21:08:34 +00:00
Fred Drake 4e303aad05 Add notes to the asctime() and ctime() descriptions to make it
explicit that locale information is not used.  There wasn't anything
that implied it was, but this has confused users.
2002-10-30 18:17:03 +00:00
Martin v. Löwis 74b51ac1e5 Patch #613256: Add nescape method to xml.sax.saxutils. 2002-10-26 14:50:45 +00:00
Fred Drake 0eebd5cef9 Implement a safer and more predictable interpolation approach.
Closes SF bug #511737.
2002-10-25 21:52:00 +00:00
Fred Drake 97d5f05221 Update to reflect the refactoring into the RawConfigParser and
ConfigParser classes.
2002-10-25 20:20:58 +00:00
Fred Drake f596826673 - The "-" format flag overrides the "0" flag, not the "-" flag.
- Documented the alternate forms, which were claimed to be documented
  but were not.
2002-10-25 16:55:51 +00:00
Fred Drake 50276abd9b Update an example to use the DOM implementation object. Explain that
the parse() and parseString() functions use a separate parser, not
actually implement a parser.  (This is a common question.)
2002-10-24 19:36:04 +00:00
Fred Drake ff287cfb4c Point to the PyXML package as an extended version of the "xml" package
that can provide this fuctionality.

Note that the docs for the xml.dom and xml.sax packages are the
definitiona of the Python bindings for the DOM and SAX interfaces.
2002-10-23 20:58:32 +00:00
Fred Drake 88f015dc88 Moved description of _urlopener adjacent to the related functions.
Added missing import to example code.

Added documentation for pathname2url(), url2pathname().
Closes SF bug #623196.
2002-10-22 21:58:06 +00:00
Fred Drake d6cf8bea0a Modify example to use string methods instead of the string module. 2002-10-22 20:31:22 +00:00
Fredrik Lundh 019bd4a6c1 terminology 2002-10-22 18:26:28 +00:00
Fredrik Lundh 1303c7cb16 add support for basic authentication, based on patch #624180
by Phillip J. Eby
2002-10-22 18:23:00 +00:00
Fred Drake 7d428ecc57 Clarify what versions of Windows are supported, and add Linux
specifically.
2002-10-22 15:06:49 +00:00
Fredrik Lundh e7c38d48ff fixed the mail address in the documentation, too... 2002-10-19 20:22:56 +00:00
Fred Drake d8eeeae4a6 Fix reference to the Fetchmail FAQ:
- URL was missing an "m"
- markup for tilde was wrong
- URL was marked as the title
- actual title was omitted

"make webcheck" didn't catch this; not sure why.

Removed some spurious end-of-line whitespace.
2002-10-18 16:50:17 +00:00
Fred Drake 5f2c1d27b9 Typo(!): "normal" -> "number" 2002-10-17 19:23:43 +00:00
Fred Drake 98ef20d5e4 Document urldefrag(). 2002-10-16 20:07:54 +00:00
Martin v. Löwis f607bdaa77 Add PyStructSequence_UnnamedField. Add stat_float_times.
Use integers in stat tuple, optionally floats in named fields.
2002-10-16 18:27:39 +00:00
Martin v. Löwis 77ac429eff Patch #572628: Optional timeouts for put and get. 2002-10-15 15:11:13 +00:00
Fred Drake 16ecb2160f Fix tildes in URLs. Closes SF bug #614821. 2002-10-12 15:02:46 +00:00
Martin v. Löwis 36a4d8c20e Remove mentionings of DOS. 2002-10-10 18:24:54 +00:00
Fred Drake 5430f4e9c8 Document when unittest was added to Python. 2002-10-10 16:16:25 +00:00
Barry Warsaw 6f0f961741 Update email micro release number. 2002-10-10 15:58:19 +00:00
Barry Warsaw df88b9fadf Document that the Charset constructor coerces its argument to lower
case.
2002-10-10 15:23:38 +00:00
Barry Warsaw 57ce1430b2 Document that get_content_charset() coerces its return value to lower
case.
2002-10-10 15:22:16 +00:00
Martin v. Löwis dbe3f76270 Patch #569139: Implementation of major, minor and makedev. 2002-10-10 14:27:30 +00:00
Fred Drake aa02c8441b Accept Armin's documentation patch for SF bug #558179.
Adjusted some markup to make the descriptions more consistent.
2002-10-09 22:33:23 +00:00
Mark Hammond 8696ebcd28 Add os.path.supports_unicode_filenames for all platforms,
sys.getwindowsversion() on Windows (new enahanced Tim-proof <wink>
version), and fix test_pep277.py in a few minor ways.
Including doc and NEWS entries.
2002-10-08 02:44:31 +00:00
Martin v. Löwis e9ce0b0fea Patch #448038: Add move(). Report errors from copytree as in shutil.Error. 2002-10-07 13:23:24 +00:00
Martin v. Löwis a844f2d165 Document patch #594001. 2002-10-05 09:46:48 +00:00
Fred Drake 0ba5541a0e Add a comment to the top of the file explaining why the file is here. 2002-10-01 18:20:16 +00:00
Barry Warsaw dd868d32e0 nits 2002-10-01 15:29:09 +00:00
Barry Warsaw de6977f441 Added an introduction. 2002-10-01 15:13:29 +00:00
Fred Drake c61617320f Stub document for the stand-alone email package distribution.
Barry, please add a reasonable abstract!
2002-10-01 14:38:47 +00:00
Fred Drake 6516e14968 Minor style nit for referring to other attributes of the same class
from an attributes description.
2002-10-01 14:29:58 +00:00
Fred Drake fcc31b44d2 Split the long email package examples into separate files and use
\verbatiminput instead of the verbatim environment -- this does the "right
thing" regarding page breaks in long examples for the typeset formats, and
has nice benefits for the HTML version as well.
2002-10-01 14:17:10 +00:00
Barry Warsaw ea66abc6e2 Cleaned up the examples. 2002-10-01 04:48:06 +00:00
Barry Warsaw 5db478fa29 Proofread and spell checked, all except the Examples section (which
I'll do next).
2002-10-01 04:33:16 +00:00
Barry Warsaw 5b9da893d3 Vast update to email version 2. This could surely use proofreading. 2002-10-01 01:05:52 +00:00
Fred Drake 2ca041fde0 items(): New method, provided by Gustavo Niemeyer in SF bug #545096. 2002-09-27 15:49:56 +00:00
Fred Drake 4613876ee3 Add deprecation notices to the documentation to reflect recent additions to
PEP 4.
2002-09-25 22:13:27 +00:00
Fred Drake 3e930ba55f Another try at clarifying what goes into and comes out of Unicode objects. 2002-09-24 21:08:37 +00:00
Fred Drake 36c2bd8e34 Remove spurious period. 2002-09-24 15:32:04 +00:00
Fred Drake 7b788e0582 Clarify that len() of a Unicode string returns the number of storage units,
not abstract characters.
2002-09-24 13:57:21 +00:00
Greg Ward 02669a35bc Tweak description of PortableUnixMailbox: "From " lines are actually
quoted (or mangled) *at* delivery-time, not "well before" it.  (At least
that's how Exim and qmail work.)
2002-09-23 19:32:42 +00:00
Thomas Heller c687401337 Fix typos: despatcher -> dispatcher. 2002-09-17 15:19:12 +00:00
Fred Drake c1ddc505d9 Minor revision to the "\\" patch, including updating the docs a little to
accomodate the fact that they are more general now that they are for the
os.path module and not just posixpath.

This and the previous patch should be combined and applied to the 2.2-maint
branch.
2002-09-12 18:01:26 +00:00
Skip Montanaro c12909bcc6 add note about os.path.join and drive letters on Windows. 2002-09-12 17:39:56 +00:00
Fred Drake b7c1895ec5 Fix typo reported by Paul Clifford.
Note that there is no str.joinfields(), use str.join() instead.
2002-09-12 14:16:07 +00:00
Fred Drake 73e8ebfc5a Revise text about the level of DOM support, and provide pointers to
the work of the XML-SIG in the main body of the text.

Modify the markup in a few places to avoid wrapping lines in bad
places, and just general cleanliness.
2002-09-11 22:03:47 +00:00
Martin v. Löwis 504bc4f3b7 Remove mentioning of Python 2.0 limitations. Fixes #607783. 2002-09-11 16:26:03 +00:00
Fred Drake 691fb55dd2 Clarify who maintains Tkinter and who maintains Tk. 2002-09-10 21:59:17 +00:00
Martin v. Löwis a32c994129 Always generate floats for stat_result; fix configure test. 2002-09-09 16:17:47 +00:00
Martin v. Löwis 94717ed1d4 Patch #606592: Subsecond timestamps in stat_result. 2002-09-09 14:24:16 +00:00
Raymond Hettinger 8a64d40949 Fix typo. Close SF Bug 606354. 2002-09-08 22:26:13 +00:00
Skip Montanaro 2c0d3224fc tightened up the definition of \b and \B some more based upon discussion
after the last checkin.
2002-09-07 18:48:14 +00:00
Walter Dörwald 5ccaf8f129 Apply diff3.txt (plus additional documentation)
from SF patch http://www.python.org/sf/554192

This adds two new functions to mimetypes:
guess_all_extensions() which returns a list of all known
extensions for a mime type, and add_type() which adds one
mapping between a mime type and an extension.
2002-09-06 16:15:58 +00:00
Skip Montanaro 2c519981fb update docs to reflect that \b considers underscore to be part of a word. 2002-09-06 14:38:23 +00:00
Raymond Hettinger d918884bb8 Fix typo 2002-09-04 23:52:42 +00:00
Raymond Hettinger a04c3d86ae Fix typo 2002-09-04 15:12:07 +00:00
Skip Montanaro 8e790e7007 expose PYTHON_API_VERSION macro as sys.api_version. Closes patch # 601456. 2002-09-03 13:25:17 +00:00
Walter Dörwald 3aeb632c31 PEP 293 implemention (from SF patch http://www.python.org/sf/432401) 2002-09-02 13:14:32 +00:00
Michael W. Hudson 53d58bb369 Further SET_LINENO reomval fixes. See comments in patch #587933.
Use a slightly different strategy to determine when not to call the line
trace function.  This removes the need for the RETURN_NONE opcode, so
that's gone again.  Update docs and comments to match.

Thanks to Neal and Armin!

Also add a test suite.  This should have come with the original patch...
2002-08-30 13:09:51 +00:00
Raymond Hettinger 9240be2a35 Note change in behavior from 1.5.2. The new argument to NameError is
an error message and not just the missing name.

Closes SF Bug 599869.
2002-08-27 23:53:23 +00:00
Fred Drake 80a04a4894 Add strong security warning about the rexec module.
Closes SF patch #600861.

Minor markup changes.
2002-08-27 16:46:06 +00:00
Tim Peters ea76c98014 Implemented <, <=, >, >= for sets, giving subset and proper-subset
meanings.  I did not add new, e.g., ispropersubset() methods; we're
going nuts on those, and, e.g., there was no "friendly name" for
== either.
2002-08-25 18:43:10 +00:00
Raymond Hettinger 7ad09552d0 Correct documentation of allow_reuse_address to match the actual script.
Closes SF bug 599681.
2002-08-25 16:27:33 +00:00
Raymond Hettinger e87ab3fefe Removed < <= > >= from the API. Implemented as comparisons of the
underlying dictionaries, there were no reasonable use cases (lexicographic
sorting of a list of sets is somewhat esoteric).  Frees the operators
for other uses (such as strict subset and superset comparisons).

Updated documentation and test suite accordingly.
2002-08-24 07:33:06 +00:00
Fred Drake 055be47b43 Fix typo reported to python-docs. 2002-08-23 21:19:53 +00:00
Raymond Hettinger fa8dd5f407 Fix markup and punctuation 2002-08-23 18:10:54 +00:00
Tim Peters b81b252fab s/_as_Temporarily_Immutable/_as_temporarily_immutable/g, because the
latter is what the code actually does.
2002-08-23 17:48:23 +00:00
Tim Peters 54fd3e6ffc pop(): An arbitrary element is removed, not a random element. 2002-08-23 17:45:43 +00:00
Fred Drake d10c6c949a Adjust the markup in a few places so this will actually format.
Remove the third column in the tables since it isn't used.
2002-08-23 17:22:36 +00:00
Raymond Hettinger 584cb198f7 Load docs for sets.py 2002-08-23 15:18:38 +00:00
Fred Drake 5ec486b87a Add a note that apply() is needed since the extended call syntax is
completely equivalent.
2002-08-22 14:27:35 +00:00
Fred Drake 61cf4407be Added a main() function and support to run this module as a script.
Closes SF feature request #588768.
2002-08-21 20:56:21 +00:00
Fred Drake 5b09eeea89 Clarify that even though some of the relevant specifications define the
order in which form variables should be encoded in a request, a CGI script
should not rely on that since a client may not conform to those specs, or
they may not be relevant to the request.
Closes SF bug #596866.
2002-08-21 19:24:21 +00:00
Fred Drake ffefb1df56 Clarify the endpos argument to the rx.match() method.
Closes SF bug #597177.
2002-08-20 13:57:47 +00:00
Neal Norwitz 11b795cd0f Add versionadded for operator.pow 2002-08-19 22:38:01 +00:00
Fred Drake 017778332f Extend some comments on the order of values in the returns from
dict.items/keys/values/iteritems/iterkeys/itervalues().
2002-08-19 21:58:58 +00:00
Guido van Rossum 45ec02aed1 SF patch 576101, by Oren Tirosh: alternative implementation of
interning.  I modified Oren's patch significantly, but the basic idea
and most of the implementation is unchanged.  Interned strings created
with PyString_InternInPlace() are now mortal, and you must keep a
reference to the resulting string around; use the new function
PyString_InternImmortal() to create immortal interned strings.
2002-08-19 21:43:18 +00:00
Raymond Hettinger 5959c559df Added __pow__(a,b) to the operator module. Completes the pattern of
all operators having a counterpart in the operator module.

Closes SF bug #577513.
2002-08-19 03:19:09 +00:00
Michael W. Hudson dd32a91cc0 This is my patch
[ 587993 ] SET_LINENO killer

Remove SET_LINENO.  Tracing is now supported by inspecting co_lnotab.

Many sundry changes to document and adapt to this change.
2002-08-15 14:59:02 +00:00
Barry Warsaw b8c20a723f More updates describing FutureWarnings. 2002-08-14 16:40:54 +00:00
Tim Peters 2f238c1b22 mkstemp's last argument changed from binary=True to text=False. 2002-08-14 16:37:10 +00:00
Guido van Rossum 830a5151c1 Doc portion of SF 589982 (tempfile.py rewrite, by Zack Weinberg).
Fred, please review!
2002-08-09 16:16:30 +00:00
Guido van Rossum b2865919cc Document that heappop() and heapreplace() raise IndexError if the heap
is empty.
2002-08-07 18:56:08 +00:00
Raymond Hettinger 22c001bd29 Described responsibilty of weakly referenced extension types to initialize
the weakreflist to NULL in the constructor and to fill the tp_flags
slot with Py_TPFLAGS_HAVE_WEAKREFS.  Closes SF bug 586583.
2002-08-07 16:18:54 +00:00
Raymond Hettinger 3cfdc3402e Documented os.fsync and os.fdatasync. Closes SF bug 584695. 2002-08-07 15:48:17 +00:00
Fred Drake 442c7c7743 Clarify that the bool instances are acceptable return values from
__nonzero__(), in response to SF bug #579991.
2002-08-07 15:40:15 +00:00
Fred Drake 95fa4ddf7b Change the markup a bit more; the parameter was not marked as \var in the
sample code, and the note was marked as a logical thing.
2002-08-07 12:39:33 +00:00
Steve Holden 63d5bead18 Fix markup errors. 2002-08-07 12:01:41 +00:00
Fred Drake 2d3c03df9a Added references to the email package.
Closes SF bug #586937.
2002-08-06 21:26:01 +00:00
Guido van Rossum 97c5fccd77 Remove mention of deprecated xreadlines method. 2002-08-06 17:03:25 +00:00
Guido van Rossum 0fc01865f3 Document file.next(). Mark xreadlines obsolete (both method and
module).  (One thing remains to be done: the gzip class has an
xreadline method; this ought to be replaced by an iterator as well.)
2002-08-06 17:01:28 +00:00
Barry Warsaw 817918cc3c Committing patch #591250 which provides "str1 in str2" when str1 is a
string of longer than 1 character.
2002-08-06 16:58:21 +00:00
Steve Holden 545092b063 Add comment about os.path.walk()'s behavior with symbolic links. 2002-08-06 16:07:07 +00:00
Neal Norwitz e72a9a13a1 SF patch #591305 Documentation err in bytecode defs 2002-08-05 23:33:54 +00:00
Raymond Hettinger acb45d72b4 Note that True and False are pickable objects 2002-08-05 03:55:36 +00:00
Steve Holden c8389c91c2 Remove a syntax error in the example, spotted by Walter Hofman. 2002-08-04 15:27:25 +00:00
Tim Peters 0ad679ff0f Document new heapreplace() function. 2002-08-03 18:53:28 +00:00
Tim Peters 6e0da82a97 Document new heapify() function. 2002-08-03 18:02:09 +00:00
Fred Drake 1acab695a7 Minor markup changes. 2002-08-02 19:46:42 +00:00
Guido van Rossum 975121664e Add docs for heapq.py. 2002-08-02 18:03:24 +00:00
Skip Montanaro de994d9130 indicate that 'b' is added to the mode flag if not given 2002-08-02 17:20:46 +00:00
Tim Peters 74824584ef Added new footnote about list.sort() stability. Repaired footnote about
using sort() with comparison functions (it made reference to the non-
existent "builtin-in function sort()").

BTW, I changed list.sort's docstring to contain the word "stable" -- the
easiest way to tell whether a particular Python version's sort *is* stable
is to look for "stable" in the docstring.  I'm not sure whether to
advertise this <wink>.
2002-08-01 03:10:45 +00:00
Fred Drake 5b11bdd0ed SF patch #581414: info reader bug
The "Matching vs. Searching" Info node is unreachable from the Info
program (but is fine in Emacs's Info mode). This patch seems to fix
it.  This is the only occurrence where the info reader fails, so
probably it could be addressed in the python docs as a workaround.
Forwarded the report to the info maintainer.
2002-07-30 17:51:20 +00:00
Martin v. Löwis 0cec0ffc78 Patch #573770: Implement lchown. 2002-07-28 16:33:45 +00:00
Fred Drake db40afaabe Small clarifications when referring to the sys.exc_* variables so that
readers are not given the wrong impression that they should be using those
on a regualar basis.
This closes SF bug #585598.
2002-07-25 21:11:23 +00:00
Jeremy Hylton 403e351dfc Flesh out description of getlogin() and recommend against using it. 2002-07-24 15:32:25 +00:00
Neal Norwitz 1cfcafceb6 add versionadded to doc 2002-07-20 00:46:12 +00:00
Guido van Rossum 18eb8b85b3 Doc patch from SF 474274 (pure Python strptime by Brett Cannon). 2002-07-19 17:09:36 +00:00
Fred Drake f0b095d804 Added documentation for the buffer_text and related attributes of the
xmlparser object provided by pyexpat, new in Python 2.3.
2002-07-17 20:31:52 +00:00
Fred Drake 2095b9690f reduce(): Clarified what is returned in the case of a sequence 1 item long and
initial/default value.
2002-07-17 13:55:33 +00:00
Guido van Rossum 9534e14033 Record the decision that StopIteration is a sink state (see recent
discussion in python-dev with subject "Termination of two-arg iter()").

Implementation will follow.
2002-07-16 19:53:39 +00:00
Guido van Rossum 54ed2d32f9 Clarify that the description of sys.path[0] is only valid upon program
start-up.
2002-07-15 16:08:10 +00:00
Fred Drake 3e59f72075 Clarify the return value of __nonzero__(): It *must* be an integer.
Closes SF bug #579991.
2002-07-12 17:15:10 +00:00
Fred Drake e4523c46b9 Document gc.get_objects().
Closes SF bug #578308.
2002-07-10 19:21:07 +00:00
Fred Drake 4254cbd29c Note that unicode() can raise LookupError for unknown codecs.
Closes SF bug #513666.
2002-07-09 05:25:46 +00:00
Fred Drake c6a525e993 Fix typo reported by Kent Engström, and a bunch of broken markup. 2002-07-08 14:42:22 +00:00
Fred Drake 50e1286c00 Fix typo: "an Unicode string" --> "a Unicode string"
Clarify the return value when the parameter is a Unicode object.
2002-07-08 14:29:05 +00:00
Steve Holden b1af86a1d7 Revise asyncore documentation and document asynchat for the first time. 2002-07-03 18:36:39 +00:00
Fred Drake 228f6e4e7a Fix up a few more consistency nits and incorrectly applied markup.
Further clarify the English-centricity of fix_sentence_endings.
2002-07-03 05:08:48 +00:00
Fred Drake c412617779 Add annotations that describe the change in the "errors" and "failures"
attributes of the TestResult.
2002-07-02 22:46:42 +00:00
Fred Drake 387c8b5f37 Update the documentation of the errors and failures attributes of the
TestResult object.  Add an example of how to get even more information for
apps that can use it.
Closes SF bug #558278.
2002-07-02 22:34:44 +00:00
Greg Ward 285f4a7db7 Don't list all the keyword args to the TextWrapper constructor in the
classdesc -- just use "..." with prose explaining the correspondence
between keyword args and instance attributes.

Document 'width' along with the other instance attributes.

Describe default values consistently.

Typo fixes.
2002-07-02 21:48:12 +00:00
Fred Drake 2c22e85ae7 Attempt to clarify removedirs().
Based on SF bug #574773.
2002-07-02 21:03:49 +00:00
Fred Drake ca23ee273e Deal with & remove the XXX comments.
Change the markup to be more like the rest of the documentation.
2002-07-02 20:37:12 +00:00
Martin v. Löwis 7d650ca83b Implement the encoding argument for toxml and toprettyxml.
Document toprettyxml.
2002-06-30 15:05:00 +00:00
Raymond Hettinger 550fd5d799 Fixed bug 574978 shutil example out of sync with source code 2002-06-30 04:43:20 +00:00
Raymond Hettinger 8a9e8b6d0e Fix bug 575221 referred to dictionary type instead of dict. 2002-06-30 04:32:38 +00:00
Fred Drake 78e057a32a Clarify the version information for the unicode() built-in.
Closes SF bug #575272.
2002-06-29 16:06:47 +00:00
Greg Ward ae64f3adcd Add documentation for new textwrap module. 2002-06-29 02:38:50 +00:00
Fred Drake 2c813818c8 Clean up some markup. 2002-06-27 18:30:34 +00:00
Neal Norwitz dcd0500664 dis.dis() also supports modules 2002-06-26 22:32:47 +00:00
Raymond Hettinger ca0383d3a3 Fix bug #573916. Sender and recipients reversed in email example. 2002-06-26 07:51:32 +00:00
Skip Montanaro 763805dab2 add seealso link to the bisect module 2002-06-26 05:22:08 +00:00
Skip Montanaro 09d9f86c77 add /F's PriorityQueue example 2002-06-26 05:07:28 +00:00
Fred Drake c5e2792ab4 Talk about interfaces rather than implementation classes where appropriate.
Add hyperlinks to make the documentation on the Attributes and AttributesNS
interfaces more discoverable.
Closes SF bug #484603.
2002-06-25 17:10:50 +00:00
Fred Drake b6aa9cbb96 Added some more links to the "See also" section. 2002-06-25 16:58:58 +00:00
Fred Drake 7bc121a4fb When talking about interfaces, use the interface names, not the names
of the implementation classes.  (Remove the "Impl" from two names.)
2002-06-25 16:25:01 +00:00
Raymond Hettinger f0236d7374 Fix typo 2002-06-25 15:26:59 +00:00
Raymond Hettinger 5ed3fa6578 Fix SF bug 568269 by enclosing 'computername' in a raw string 2002-06-25 04:53:05 +00:00
Neal Norwitz 563d12d145 SF # 572928 One word change for lib/libgettext.tex
Fix typo.
2002-06-24 02:22:39 +00:00
Fred Drake 53540ab071 Correct the RE equivalent of scanf()'s %x and %X patterns.
Closes SF bug #572169.
2002-06-22 01:07:37 +00:00
Fred Drake 473f46a853 Make the docs for string.capitalize() match those of str.capitalize()
(which makes it more clear).
Closes SF bug #571767.
2002-06-20 21:18:46 +00:00
Fred Drake 807354f3b6 Add a note that divmod() with complex numbers is deprecated. 2002-06-20 21:10:25 +00:00
Fred Drake dce695aa4e Added reference to the Expat home page. 2002-06-20 21:06:03 +00:00
Fred Drake f4bf7aa292 Typo: bites --> bytes
(Hanging around small kids too much...;)
2002-06-18 20:38:05 +00:00
Fred Drake 9ea01d415f Add description of the deadlock problem with child processes and pipes, and
hints about how to work around it.
Closes SF bug #530637.
2002-06-18 20:30:37 +00:00
Fred Drake 69d1fd2fdb Note the limitation that mime_decode_header() only works for Latin-1.
Closes SF bug #551912.
2002-06-18 18:51:30 +00:00
Fred Drake 7f59124693 Clarified documentation for os.access().
Patch contributed by Sean Reifschneider.
Closes SF patch #570618.
2002-06-18 16:15:51 +00:00
Fred Drake 28bdc624a8 Clarified description of error handling for shutil.rmtree().
This closes SF patch #569832.
2002-06-18 14:31:04 +00:00
Piers Lauder 3fca291a52 Add IMAP4 QUOTA extension methods 2002-06-17 07:07:20 +00:00
Steve Holden 1e4519faaa Make a start at describing the results of class/type unification
in the type documentation.
2002-06-14 09:16:40 +00:00
Fred Drake 6c123efe3d Refer the reader to the correct module for constant definitions.
This closes SF bug #550777.
2002-06-14 01:58:19 +00:00
Fred Drake 585775bf11 Document the Binary.data attribute.
This closes SF bug #562878.
2002-06-14 00:33:02 +00:00
Neal Norwitz 9c92b69a54 Use \code{True} (or False) instead of true/false.
Not sure if code is correct, but that is what's in this file.
I've seen \constant{True} in other places.
2002-06-14 00:27:13 +00:00
Neal Norwitz cc5c6947a6 Add "version added" for getpgid 2002-06-13 21:19:25 +00:00
Martin v. Löwis 606edc1d97 Patch #568235: Add posix.setpgid. 2002-06-13 21:09:11 +00:00
Guido van Rossum fea59e7f76 The opcode FOR_LOOP no longer exists. 2002-06-13 17:59:51 +00:00
Fred Drake efb9097add Do not claim that getlocale() returns a tulpe; that is not always true.
Closes SF bug #568577.
2002-06-13 17:54:06 +00:00
Guido van Rossum 11ba094957 Major overhaul of timeout sockets:
- setblocking(0) and settimeout(0) are now equivalent, and ditto for
  setblocking(1) and settimeout(None).

- Don't raise an exception from internal_select(); let the final call
  report the error (this means you will get an EAGAIN error instead of
  an ETIMEDOUT error -- I don't care).

- Move the select to inside the Py_{BEGIN,END}_ALLOW_THREADS brackets,
  so other theads can run (this was a bug in the original code).

- Redid the retry logic in connect() and connect_ex() to avoid masking
  errors.  This probably doesn't work for Windows yet; I'll fix that
  next.  It may also fail on other platforms, depending on what
  retrying a connect does; I need help with this.

- Get rid of the retry logic in accept().  I don't think it was needed
  at all.  But I may be wrong.
2002-06-13 15:07:44 +00:00
Fred Drake e9996c6093 Add version annotations for some older changes to the calendar module.
Closes SF patch #567867.
2002-06-13 01:34:50 +00:00
Guido van Rossum e3fdc975c0 SF bug 567826. Document new opcodes:
['BINARY_FLOOR_DIVIDE', 'BINARY_TRUE_DIVIDE',
'INPLACE_FLOOR_DIVIDE', 'INPLACE_TRUE_DIVIDE', 'GET_ITER',
'YIELD_VALUE', 'FOR_ITER', 'CONTINUE_LOOP']
2002-06-12 15:33:08 +00:00
Michael W. Hudson 5efaf7eac8 This is my nearly two year old patch
[ 400998 ] experimental support for extended slicing on lists

somewhat spruced up and better tested than it was when I wrote it.

Includes docs & tests.  The whatsnew section needs expanding, and arrays
should support extended slices -- later.
2002-06-11 10:55:12 +00:00
Guido van Rossum a861d552c3 Document that the key should not contain null bytes. 2002-06-10 19:42:43 +00:00
Guido van Rossum db9198a8b5 SF bug 563750 (Alex Martelli): posix_tmpfile():
The file returned by tmpfile() has mode w+b, so use that in the call
to PyFile_FromFile().

Bugfix candidate.
2002-06-10 19:23:22 +00:00
Guido van Rossum 715b861d94 Clarify the interaction between timeout/non-blocking mode, makefile
and fromfd.
2002-06-07 12:38:23 +00:00
Neal Norwitz 62a7f63a24 Fix typo 2002-06-07 12:36:44 +00:00
Guido van Rossum fc9823b1a9 Clarify the interaction between blocking and timeouts. Explain that
fromfd() assumes a blocking non-timeout socket.
2002-06-07 03:39:21 +00:00
Neal Norwitz bdbd84fdac Add version info, and fix another typo and wording spotted by /F. I think this is what he meant. :-) 2002-06-06 22:24:10 +00:00
Fred Drake 1a06fb0605 Fix typo spotted by Fredrik Lundh. 2002-06-06 22:19:20 +00:00
Fred Drake 6c6d662760 Fix some markup errors and adjust wording slightly. 2002-06-06 21:57:48 +00:00
Guido van Rossum be946bfea7 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
I've made considerable changes to Michael's code, specifically to use
the select() system call directly and to store the timeout as a C
double instead of a Python object; internally, -1.0 (or anything
negative) represents the None from the API.

I'm not 100% sure that all corner cases are covered correctly, so
please keep an eye on this.  Next I'm going to try it Windows before
Tim complains.

No way is this a bugfix candidate. :-)
2002-06-06 21:51:01 +00:00
Martin v. Löwis 446a25fa3c Patch 473512: add GNU style scanning as gnu_getopt. 2002-06-06 10:58:36 +00:00
Walter Dörwald 474458da48 Add constants BOM_UTF8, BOM_UTF16, BOM_UTF16_LE, BOM_UTF16_BE,
BOM_UTF32, BOM_UTF32_LE and BOM_UTF32_BE that represent the Byte
Order Mark in UTF-8, UTF-16 and UTF-32 encodings for little and
big endian systems.

The old names BOM32_* and BOM64_* were off by a factor of 2.

This closes SF bug http://www.python.org/sf/555360
2002-06-04 15:16:29 +00:00
Guido van Rossum 59b2a74c75 SF bug 533625 (Armin Rigo). rexec: potential security hole
If a rexec instance allows writing in the current directory (a common
thing to do), there's a way to execute bogus bytecode.  Fix this by
not allowing imports from .pyc files (in a way that allows a site to
configure things so that .pyc files *are* allowed, if writing is not
allowed).

I'll apply this to 2.2 and 2.1 too.
2002-05-31 21:12:53 +00:00
Fred Drake 9b414ac93e Update links and information on PyQt/PyKDE. 2002-05-31 18:21:56 +00:00
Neal Norwitz d68f5171eb As discussed on python-dev, add a mechanism to indicate features
that are in the process of deprecation (PendingDeprecationWarning).
Docs could be improved.
2002-05-29 15:54:55 +00:00
Michael W. Hudson 34f20eac98 This is patch
[ 559250 ] more POSIX signal stuff

Adds support (and docs and tests and autoconfery) for posix signal
mask handling -- sigpending, sigprocmask and sigsuspend.
2002-05-27 15:08:24 +00:00
Fred Drake 92bf9dacc9 Markup adjustments; fix the names of modules referenced in an expression. 2002-05-23 21:07:19 +00:00
Raymond Hettinger c32f0336e0 Deprecated Random.cunifvariate clearing bug 506647. Also, added docstrings. 2002-05-23 19:44:49 +00:00
Fred Drake 7779b208ae Remove spurious "()" from the __str__() description. 2002-05-22 20:44:03 +00:00
Barry Warsaw 177b4a065f Jack's documentation for the U mode character on the file()
constructor, vetted by Barry.
2002-05-22 20:39:43 +00:00
Fred Drake c58507582b Added a version annotation for StringTypes.
Added documentation for BooleanType.
2002-05-22 02:44:24 +00:00
Barry Warsaw c421ad4a35 Minor typo: Message.getall() -> Message.get_all() 2002-05-22 01:22:46 +00:00
Raymond Hettinger 6cf09f0792 Patch 543387. Document deprecation of complex %, //,and divmod(). 2002-05-21 18:19:49 +00:00
Raymond Hettinger 97394bc795 Patch 533291. Deprecate None return form of __reduce__. 2002-05-21 17:22:02 +00:00
Fred Drake 5ecb7aaa6a Add availability information for a couple of the types, and notes on writing
string-type tests for versions of Python built without Unicode support.
2002-05-21 14:28:22 +00:00
Raymond Hettinger cadc9fbd37 Patch 547037. Corrected documentation to match
actual module behavior for adding newlines.
2002-05-16 04:28:44 +00:00
Raymond Hettinger b07fa39edf Added missing index entries for mapping methods. Closes patch #548693. 2002-05-15 15:45:25 +00:00
Raymond Hettinger 576474c5ae Closes SF bug 527139. Brings docs inline with random.py 1.29
which fixes the unnecessarily restricted method domain.
2002-05-13 23:49:13 +00:00
Raymond Hettinger 5359ad63ce Correct gammavariate's method name and domain.
Partial solution to SF bug 527139.
2002-05-13 22:40:38 +00:00
Raymond Hettinger c045b49633 Added degrees() and radians() to mathmodule. Closing patch 552452 and
feature request 426539.
2002-05-13 03:52:47 +00:00
Fred Drake 1f89e2abcc Fix markup error that suppressed space.
Closes SF bug #554257.  Not relevant to older releases.
2002-05-10 12:37:56 +00:00
Fred Drake d05c74f42d Add a note explaining the interaction between unbuffered input and
xreadlines.xreadlines().
This closes SF patch #552804.
2002-05-06 16:02:42 +00:00
Fred Drake b9032018ff Update the xrange object description to reflect the removal of deprecated
features.
2002-05-02 21:37:23 +00:00
Fred Drake 4d707a5d08 Remove extra period produced by previous change. 2002-05-02 17:54:18 +00:00
Fred Drake 4b270518b7 Correct information on support for repietition & concatenation for buffer
and xrange objects.
This closes SF bug #550555.
2002-05-02 05:56:04 +00:00
Fred Drake 7f781c9aab Add Pickler.clear_memo() so the pickle and cPickle modules are more similar. 2002-05-01 20:33:53 +00:00
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
Fred Drake 52cc670711 Add a note about when the "%r" formatting code was added. 2002-04-30 14:54:47 +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
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
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 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
Skip Montanaro b02ea65f92 typo 2002-04-17 19:33:06 +00:00
Fred Drake 933f159a2f Add a version annotation for the help() function. 2002-04-17 12:54:04 +00:00
Skip Montanaro 6c7bc31089 added small clarification to the descriptions of encode() and decode() 2002-04-16 15:12:10 +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
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
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 d4c0e5fd5b BDFL agreed with Tim: rehabilitate randint(). 2002-04-12 20:01:47 +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 81bdc93d2f Explain octal escapes. Fixes #542226. 2002-04-11 12:24:12 +00:00
Andrew M. Kuchling 2854c478be Remove mention of 'pre' module
(2.2 bugfix candidate?)
2002-04-10 21:28:31 +00:00
Skip Montanaro 3b2625ff82 document all the valid encoding values 2002-04-10 04:37:09 +00:00
Neal Norwitz 6b35370c65 Update docs for bool changes by Guido around April 6 2002-04-09 18:15:00 +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
Neal Norwitz d3dab2b192 Update doc to reflect Tim's changes to bool. 2002-04-05 02:21:09 +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
Neal Norwitz ce5df49957 SF 539024, Fix broken link to numpy 2002-04-04 14:02:45 +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 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 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
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 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
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
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 79f181395b Add more example exceptions that unpickling can raise. 2002-03-22 22:16:03 +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 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 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
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 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
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
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
Piers Lauder a4f8313cbb add SSL class submitted by Tino Lange 2002-03-08 01:53:24 +00:00
Fred Drake da8a6dd072 Added missing version annotation for dict(). 2002-03-06 02:29:30 +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
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
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 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
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
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
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
Fred Drake 7731ed47cb Do not mask the name of a built-in function in example code.
Based on comment sent to python-docs.
2002-01-05 04:00:03 +00:00
Fred Drake 5e74d36f9d Fix indentation error in example from the Tkinter Life Preserver.
This closes SF bug #499505.
2002-01-05 03:56:54 +00:00
Fred Drake d93d68bd13 Fix minor typo reported in SF patch #497951. 2002-01-05 01:52:41 +00:00
Guido van Rossum c33e077838 SF patch #497420 (Eduardo Pérez): ftplib: ftp anonymous password
Instead of sending the real user and host, use "anonymous@" (i.e. no
host name at all!) as the default anonymous FTP password.  This avoids
privacy violations.
2001-12-28 20:54:28 +00:00
Fred Drake 7c9a53dfc0 Elaborate the descriptions for onecmd(), precmd(), and postcmd() so they are
useful.
2001-12-27 05:10:18 +00:00
Fred Drake fd7f115a0e Fix wrongly-named formal parameters in three places: begin_y was used twice
instead of begin_y and begin_x for derwin(), subpad(), and subwin().
Reported for derwin() by Eric Huss.

Added class annotations for the window methods so they would be properly
described in the index.
2001-12-26 22:08:44 +00:00
Fred Drake ab2dc1d730 Added index entries similar to some recommended by Skip, and used the word
"interpolation" in the text, to make the string formatting material easier to
find.
This closes SF bug #487165.
Bugfix: this should be applied for Python 2.2.1.
2001-12-26 20:06:40 +00:00
Fred Drake ef338ec5f9 More index entries. 2001-12-26 19:48:43 +00:00
Fred Drake 39960f6ec9 Fix the erroneous availability annotation for s.makefile() from the last
checkin (my fault!).
Wrap some long lines and fix some markup inconsistencies.
2001-12-22 19:07:58 +00:00
Fred Drake 87fa3aa12c Add notes that fromfd() and s.makefile() are Unix-specific.
This fixes SF bug #495896.

Fix up various markup consistency & style guide conformance nits.
2001-12-21 17:45:03 +00:00
Fred Drake 5c7983113c Add a reference to the signal module to the os.kill() description.
This closes SF bug #495609.
2001-12-21 03:58:47 +00:00
Fred Drake dce2e1161a Fix typo in httplib example.
This fixes SF bug #495221.
2001-12-21 03:52:04 +00:00
Fred Drake 8c8e871530 Fix the availability statement for the spawn*() functions to reflect the
actual availability on Windows.
This fixes SF bug #495191.
2001-12-20 17:24:11 +00:00
Fred Drake 34a37b807a Re-commit Ping's patch to the cgi and cgitb documentation, using the
right version this time.  Thanks, Ping!
(This was from SF patch #494582, "\index -> \indexii" version.)
2001-12-20 17:13:09 +00:00
Fred Drake 4b1b3bfac1 Add entry for the pydoc documentation. 2001-12-18 16:32:30 +00:00
Fred Drake 96be564027 Add documentation for the pydoc module; contributed by Ka-Ping Yee.
This closes SF patch #494622.
2001-12-18 16:31:44 +00:00
Fred Drake 732299ff63 Add documentation for the help() built-in; contributed by Ka-Ping Yee.
This is part of SF patch #494622.
2001-12-18 16:31:08 +00:00
Fred Drake e088970ce0 Merge in Ping's changes to the cgitb documentation, and add a version
annotation as well.
This closes SF patch #494582.
2001-12-18 15:51:55 +00:00
Fred Drake 0c0b5305ae Mark the mpz module deprecated as of Python 2.2. 2001-12-16 01:54:55 +00:00
Fred Drake c57772870b Add a link to the mxNumber package. 2001-12-15 20:37:40 +00:00
Fred Drake b40501b05e Add link to the gmpy project. 2001-12-15 18:37:24 +00:00
Fred Drake dda7dcb3f7 Add a missing "cycle". 2001-12-14 21:19:08 +00:00
Fred Drake 526c7a0101 Ensure that complex() only accepts a string argument as the first arg,
and only if there is no second arg.
This closes SF patch #479551.
2001-12-13 19:52:22 +00:00
Fred Drake a0b767625b Minor adjustments. 2001-12-13 04:25:37 +00:00
Fred Drake 1529ef860e Document that isleap() returns exactly 1 or 0, which is guaranteed by the
docstring.
This closes SF bug #485794.


Additional (very) small details were added.
2001-12-12 05:40:46 +00:00
Fred Drake cf72abab8c Update link to the SAX homepage. 2001-12-10 18:10:37 +00:00
Fred Drake 6048ce95a9 Added documentation for str.decode().
This closes SF bug #490823.
2001-12-10 16:43:08 +00:00
Guido van Rossum 146483964e Patch supplied by Burton Radons for his own SF bug #487390: Modifying
type.__module__ behavior.

This adds the module name and a dot in front of the type name in every
type object initializer, except for built-in types (and those that
already had this).  Note that it touches lots of Mac modules -- I have
no way to test these but the changes look right.  Apologies if they're
not.  This also touches the weakref docs, which contains a sample type
object initializer.  It also touches the mmap test output, because the
mmap type's repr is included in that output.  It touches object.h to
put the correct description in a comment.
2001-12-08 18:02:58 +00:00
Fred Drake f9d580346b Add change notes where im_class is discussed, since the exact meaning changes
with Python 2.2.
2001-12-07 23:13:53 +00:00
Guido van Rossum b62f0e1a7b Correct the description of im_class. (Fred, this is changed in 2.2.
Should this be labeled as changed?  How?)
2001-12-07 22:03:18 +00:00
Fred Drake 7961930595 Revise description of dumbdbm.open() to reflect that the flag argument is
ignored and that mode was ignored before Python 2.2.
This closes SF bug #490098.
2001-12-07 21:56:13 +00:00
Fred Drake 8b7bb7a0f2 Describe the behavior of the read() method when the list of filenames
includes files that do not exist, explain the intended use of the interface,
and show how to ensure an expected file really exists.
This closes SF bug #490399.
2001-12-07 21:35:57 +00:00
Tim Peters b404145936 s/it/if/ in descriptions of spawn mode argument. 2001-12-06 23:37:17 +00:00
Tim Peters c7cb69263d For ratecv, document that None should be the initial state argument (when
I was squashing spurious overflows in the implementation, I got hung up
on this point).
2001-12-06 23:16:09 +00:00
Fred Drake a16433b14e Re-enabled debugging prints in poplib & documented the set_debuglevel()
method.
This closes SF patch #486079.
2001-12-05 22:37:21 +00:00
Fred Drake d761662b66 asyncore.loop() description contributed by Skip Montanaro.
This closes SF bug #489513.
2001-12-05 21:37:50 +00:00
Fred Drake 39368c1053 Added documentation of the sendall() method, and a note to the send() method
that it does not guarantee that all data is sent.
This closes SF patch #474307.
2001-12-05 05:25:59 +00:00
Fred Drake d2a557e51e Added entry for the "cgitb" module docs. 2001-12-04 22:48:17 +00:00
Fred Drake 6e70e8b401 Documentation for the "cgitb" module. 2001-12-04 22:47:42 +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
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 1a76386194 Added documentation on the ScrolledText module. 2001-12-03 21:18:30 +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 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 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 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 0467775715 Add description of tkCommonDialog. 2001-11-30 19:24:49 +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 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 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 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 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
Martin v. Löwis 560da62fc7 Rename get_referents to get_referrers. Fixes #483815. 2001-11-24 09:24:51 +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 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
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 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 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
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
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
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 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
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 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 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 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 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
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 ef7d08a661 Some style changes and typo fixes. 2001-10-26 15:04:33 +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 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 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
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 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 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 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 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
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 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
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
Barry Warsaw c7f8b86307 Describe the HeaderParser class. 2001-10-11 15:45:05 +00:00
Tim Peters 8cd015c701 A copy-and-paste job forget the "paste" half. 2001-10-09 20:54:23 +00:00
Tim Peters 659a60311d Allow the profiler's calibration constant to be specified in the constructor
call, or via setting an instance or class vrbl.
Rewrote the calibration docs.
Modern boxes are so friggin' fast, and a profiler event does so much work
anyway, that the cost of looking up an instance vrbl (the bias constant)
per profile event just isn't a big deal.
2001-10-09 20:51:19 +00:00
Barry Warsaw dca939899d Fix minor cut-and-paste typo. 2001-10-09 19:37:51 +00:00
Fred Drake e0063d20a7 Update the documentation for the isinstance() function to reflect recent
changes in the implementation.
Indented all descriptions consistently.
2001-10-09 19:31:08 +00:00
Barry Warsaw a55d132f08 Add documentation for the MIMEAudio class/module, contributed by
Anthony Baxter.
2001-10-09 19:14:17 +00:00
Fred Drake 938a8d723c Improve the documentation for the os.P_* constants used with the os.spawn*()
functions to include information about how they affect the operation of
those functions when used as the "mode" parameter.
This closes SF bug #468384.

Added warnings to the os.tempnam() and os.tmpnam() functions regarding their
security problem.  These warning mirror the warnings added to the runtime
by Skip Montanaro.
2001-10-09 18:07:04 +00:00
Fred Drake 6959a2fcd7 Note that the values for Boolean options are case-insensitive. 2001-10-09 14:58:24 +00:00
Fred Drake b35f0ce2b8 Update the description of getboolean() to reflect the changes made by
SF patch #467580.
2001-10-08 16:03:20 +00:00
Tim Peters 0a1fc4e389 Remove code and docs for the OldProfile and HotProfile classes: code
hasn't worked in years, docs were wrong, and they aren't interesting
anymore regardless.
2001-10-07 03:12:08 +00:00
Fred Drake 8c2c3d301b Update the documentation to reflect the changes to ReferenceError. 2001-10-06 06:10:54 +00:00
Tim Peters 9835206268 A regexp example was rendered as
foo\d
when it was clearly intended to render as
    foo$
Fred, is this a right way to fix it?  If not, the earlier place in the
same paragraph that does render as
    foo$
is also wrong.
2001-10-05 20:06:47 +00:00
Martin v. Löwis 244edc8985 Add chroot call. Implements feature #459267. 2001-10-04 22:44:26 +00:00
Fred Drake fcc16330a4 Update a couple of old addresses that point to CNRI. 2001-10-04 20:40:07 +00:00
Tim Peters 3899d74c10 Make clear that tuple() accepts the same kind of arguments as list(). 2001-10-04 06:53:20 +00:00
Tim Peters 0481d24dd5 CVS patch [#466628] Doc changes for doctest patch (#466616), from
Tim Hochberg.  Doctest no longer searches imported objects.
2001-10-02 21:01:22 +00:00
Fred Drake d90f509b8f Fredrik tells me the truefalse parameter for boolean() is not part of the
public interface, so we can simplify the documentation.
2001-10-01 21:05:30 +00:00
Fred Drake 6c81e2a44f "boolean" --> "Boolean" (per the style guide). 2001-10-01 17:04:10 +00:00