Commit Graph

2877 Commits

Author SHA1 Message Date
Tim Peters b01c39bb94 SF bug 671779: Error in tzinfo.dst() docs
tzinfo dst() should return timedelta(0) if DST is not effect, not 0.
2003-01-21 16:44:27 +00:00
Skip Montanaro 1f7a271f0b more tweaks 2003-01-21 01:52:39 +00:00
Skip Montanaro 190613cee9 * document open() function
* promote the example and the documented restrictions to \subsection status
* document the flag parameter of the DbfilenameShelf class
2003-01-21 01:38:47 +00:00
Tim Peters 327098a613 New rule for tzinfo subclasses handling both standard and daylight time:
When daylight time ends, an hour repeats on the local clock (for example,
in US Eastern, the clock jumps from 1:59 back to 1:00 again).  Times in
the repeated hour are ambiguous.  A tzinfo subclass that wants to play
with astimezone() needs to treat times in the repeated hour as being
standard time.  astimezone() previously required that such times be
treated as daylight time.  There seems no killer argument either way,
but Guido wants the standard-time version, and it does seem easier the
new way to code both American (local-time based) and European (UTC-based)
switch rules, and the astimezone() implementation is simpler.
2003-01-20 22:54:38 +00:00
Raymond Hettinger 9543b34006 SF patch #670423: Add missing identity tests to operator.c 2003-01-18 23:22:20 +00:00
Fred Drake 42b567fce9 Fix a couple of markup errors. 2003-01-17 22:47:33 +00:00
Skip Montanaro a5caa6fcd9 reference the os module and the lock flags in the os.open() function.
(Someone please review what I wrote for accuracy.)
2003-01-15 21:08:19 +00:00
Raymond Hettinger 3801ec7ff3 Document that __cmp__() is not defined for sets.
Note, that list.sort() is undefined for lists of sets.
Add the ... prompt to the example so it runs in doctest.
2003-01-15 15:46:05 +00:00
Martin v. Löwis 0c6774d92b Patch #661719: Expose compilation errors as exceptions on request. 2003-01-15 11:51:06 +00:00
Martin v. Löwis d69663d300 Patch #473586: Implement CGIXMLRPCRequestHandler. 2003-01-15 11:37:23 +00:00
Raymond Hettinger 2bd1568d35 SF patch 664183 and SF bug 664044: Note that both u'%s' % 'x' and
'%s' % u'x'  return a unicode object.
2003-01-13 04:29:19 +00:00
Neal Norwitz 06daee9dd7 Try to make a sentance more readable. 2003-01-12 15:04:54 +00:00
Neal Norwitz e68fbc44aa SF #665570, curses causes interpreter crash
The interpreter doesn't crash, but it does call exit() in libncurses.
Add a note to this effect.

Will backport
2003-01-12 14:56:19 +00:00
Fred Drake 8ec17a0a8d Minor correction and clarification. 2003-01-11 23:15:47 +00:00
Neal Norwitz 3cb68a2512 Remove extra 'types'
Change a couple of list -> mylist
2003-01-10 13:52:30 +00:00
Raymond Hettinger 6fe1299b09 SF bug #652888: bad documentation for the "type" builtin
Clarified that not all types are included.  The OP was looking for a
StaticMethodType.

Also, added a note and example suggesting the use of int,str, etc.
instead of IntType, StrType, etc.

Renamed the crummy variable name in the example from "list" to "mylist".
2003-01-10 09:33:08 +00:00
Tim Peters 312141c51f Purged reference to defunct datetimetz. 2003-01-09 19:52:17 +00:00
Andrew M. Kuchling 9b44571caa Various minor edits 2003-01-09 13:46:30 +00:00
Andrew M. Kuchling 0f0e6b9d48 Markup fix 2003-01-09 12:51:50 +00:00
Tim Peters 003720235b Massive fiddling to reflect that datetimetz and timetz no longer exist.
WARNING:  It would be a minor miracle if the LaTeX stuff still worked.

s/field/member/ generally everywhere, to conform with most other usage in
the docs.

s/daylight savings time/daylight saving time/ generally everywhere,
because the latter spelling is anally correct.
2003-01-09 04:10:05 +00:00
Fred Drake 326c72a839 Add notes about the linuxaudiodev and ossaudiodev modules. 2003-01-08 07:21:53 +00:00
Greg Ward 19b6f60f5c There's no such method as has_option() -- should be has_extn(). 2003-01-08 03:04:42 +00:00
Barry Warsaw b6604b3e69 Document EX_OK and friends. 2003-01-07 22:43:25 +00:00
Neal Norwitz 051314f924 SF #664011, move tarfile module in docs 2003-01-07 22:36:04 +00:00
Raymond Hettinger 8ef3d8d5d1 Fix spelling. 2003-01-06 18:41:01 +00:00
Neal Norwitz 488609e43a SF #642236, optparse LaTeX docs by Johannes Gijsbers 2003-01-06 16:51:37 +00:00
Fred Drake 11f89b75e1 Strike any hint that from-import-* could ever be reasonable; it's a
vile abomination and should be eradicated!
2003-01-06 16:38:10 +00:00
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