Commit Graph

6002 Commits

Author SHA1 Message Date
Brett Cannon 235d1efe12 Add docs for key_file and cert_file arguments for HTTPSConnection. Copied from socket.ssl docs. 2003-05-20 02:56:35 +00:00
Skip Montanaro 7789237331 * Correct Sniffer doc to correspond to the implementation.
* Add optional delimiters arg to Sniffer.sniff() which restricts the set of
  candidate field delimiters.
2003-05-19 15:33:36 +00:00
Walter Dörwald 9e46abed50 Fix array.array.insert(), so that it treats negative indices as
being relative to the end of the array, just like list.insert() does.
This closes SF bug #739313.
2003-05-18 03:15:10 +00:00
Raymond Hettinger 047c54bb24 Missing parenthesis. 2003-05-16 14:36:26 +00:00
Jim Fulton 1f325562f0 Added some missing PyObject* casts in the deallocators.
Added some defines for PyMODINIT_FUNC so that the examples work
with Python 2.2.

I think I'm done hacking this documentation. Yippie! :)
2003-05-16 13:53:43 +00:00
Jim Fulton a24d73ddb1 Added a missing PyObject* cast to the dealloc examples.
Added a note that the mechanism for defining new tyoes documented here
only works for Python 2.2 and higher.
2003-05-16 13:51:58 +00:00
Jim Fulton aea763bde7 Removed reference to the out-of-date (and not very useful)
Objects/xxobject.c example.

Updated the discussion of type checking to refer to
PyObject_TypeCheck.
2003-05-16 13:32:59 +00:00
Guido van Rossum 8f512a22cd Add docs for MessageBeep. 2003-05-16 01:42:22 +00:00
Andrew M. Kuchling 7696344182 [Bug #471893] Replace security material with a warning against unpickling
untrusted data.
2003-05-14 16:51:46 +00:00
Fred Drake 126d366ea6 document Stats.dump_stats(), new for Python 2.3 2003-05-14 14:29:27 +00:00
Fred Drake c868d16e11 When an external application we use exits normally, exit with the same
exit code they returned.  All other types of exit from child processes
are normalized to a return code of 1.
Closes SF bug #732143.
2003-05-14 04:16:14 +00:00
Guido van Rossum bf1bef820c Add optional 'onerror' argument to os.walk(), to control error
handling.
2003-05-13 18:01:19 +00:00
Andrew M. Kuchling e9a54a3eaf [Bug #713722] Delete dangling references to unwritten sections 2003-05-13 15:02:06 +00:00
Andrew M. Kuchling c85bf58276 [Bug #732124] Clarify .pos, .endpos by saying 'method' instead of 'function'
Also, put match() description before search(); search() refers to match()
2003-05-13 14:40:24 +00:00
Andrew M. Kuchling 8d17709c5c Remove more markup from headers 2003-05-13 14:26:54 +00:00
Andrew M. Kuchling 433307b75d [Bug #729297] Remove markup in section headers 2003-05-13 14:23:54 +00:00
Andrew M. Kuchling eabd9a1314 [Bug #729817] Document the rexec and Bastion modules as dead 2003-05-13 14:16:18 +00:00
Andrew M. Kuchling 032bd0a9a8 Fix typo 2003-05-13 14:13:58 +00:00
Brett Cannon 1213bdd16d Fix and add reference to urllib.urlencode for parse_qsl? functions. 2003-05-13 02:50:36 +00:00
Jim Fulton d2eadc6946 Updated simple example. This should have been checked in the other
day, but I missfired in CVS.
2003-05-12 17:42:56 +00:00
Fred Drake 7af9f4dac3 Add a specific mention of the term "operator overloading" and add an
index entry.  Suggested to python-docs.
2003-05-12 13:50:11 +00:00
Raymond Hettinger bf3a75283c Fix minor typos. 2003-05-12 03:23:51 +00:00
Fred Drake 8f53cdcfce - object is a class type, not a function
- when marking a function, the trailing () should be included
  consistently
2003-05-10 19:46:39 +00:00
Raymond Hettinger b4c1d9be8f Fix unbalanced parethesis. 2003-05-10 08:51:28 +00:00
Raymond Hettinger 0dfd7a9361 Missing parenthesis found by texcheck.py 2003-05-10 07:40:56 +00:00
Martin v. Löwis 5467d4c0e3 Patch #612627: Add encoding attribute to file objects, and determine
the terminal encoding on Windows and Unix.
2003-05-10 07:10:12 +00:00
Raymond Hettinger eca984fcce Fix missing parenthesis. 2003-05-10 04:21:08 +00:00
Raymond Hettinger 52136a8bea Fixed spacing and unbalanced brackets or parenthesis. 2003-05-10 03:35:37 +00:00
Fred Drake 9f545c489a Make this format again. 2003-05-09 19:10:12 +00:00
Skip Montanaro a30dffbb53 add a note about accessing user-defined functions with an import statement
in the setup parameter
2003-05-09 18:21:02 +00:00
Fred Drake 3ec4dfd812 Make this format again. 2003-05-09 18:18:46 +00:00
Fred Drake 8b6ed26dc7 - remove bogus \end{description}
- fix two typos
2003-05-09 15:04:56 +00:00
Jack Jansen 1662162c04 Documented the new autoGIL module. 2003-05-09 14:45:04 +00:00
Jim Fulton 3ff5bb20b7 Fixed small typo Pointed out by Michael Hudson. 2003-05-08 10:35:07 +00:00
Jim Fulton 83cedcf660 Fixed a typo in an example dealloc routine that calls it's "self"
argument "obj" rather than "self".
2003-05-08 10:32:10 +00:00
Greg Ward 86e1790cad Clarify the dedent() example a bit by indenting the input lines unevenly. 2003-05-08 02:12:35 +00:00
Greg Ward 8f6329c547 SF patch #598163 (Ville Vainio, vvainio@users.sourceforge.net):
document dedent() function.
2003-05-08 02:09:49 +00:00
Brett Cannon 066f3928b2 Library documentation for the 'test' package. Still needs to be checked by Fred. 2003-05-07 22:02:17 +00:00
Jim Fulton aed0a4a138 Rewrote the basic section of the chapter on defining new types.
Changed the example to show how to create types the new way:

- Use a class new method rather than a new function.

- Use self->ob_type->tp_free in deallocators

- Use attribute descriptors rather than set/getattr methods.

- Make the type usable as a base type.

I split the example into 3 parts:

1. The minimal new type

2. Adding attributes and methods.

3. Finer control over attributes.

It's much simpler to define builtin types. These updates hopefully
show this.

I also made minor wording changes in two other places.

I still need to update xxobject.c
2003-05-07 19:48:13 +00:00
Raymond Hettinger a02469f969 More message updates and minor fixes. 2003-05-07 17:49:36 +00:00
Raymond Hettinger a2f84ceda5 Update traceback message 2003-05-07 17:11:15 +00:00
Andrew M. Kuchling fcf6b3ecde Add list.insert() change for negative positions
Add ~ to MvL's last name
Fix use of all-caps for a name
Bump version number
2003-05-07 17:00:35 +00:00
Skip Montanaro 45a9c93236 add missing parens - verified w/ interpreter - sorry to dismiss your comment
Fred
2003-05-07 16:01:43 +00:00
Skip Montanaro b4f12424a5 replace most uses of `...` by repr(...), noting that `...` is discouraged,
but convenient in interactive sessions.
2003-05-07 15:29:12 +00:00
Skip Montanaro 6d9f45bc3f add a note about the undocumented bsddb185 module 2003-05-06 20:40:17 +00:00
Jeremy Hylton 6cb52ddc3c Refer reader to platform library docs for specific semantics.
Resolves SF bugs 697989, 697988, 697986.
2003-05-05 16:46:26 +00:00
Greg Ward d72312857e Scattered wording and typographical improvements (up to but not
including the "Callback Options" section).
2003-05-03 21:22:58 +00:00
Greg Ward 649625bc05 Rename "The Tao of Option Parsing" section to "Philosophy".
Remove first-person usage from it.  Various wording tweaks.
2003-05-03 20:41:37 +00:00
Greg Ward 1f53517a8c Use True/False instead of 1/0 when talking about store_true/store_false.
Particularly important since they now store True and False rather than 1
and 0!
2003-05-03 20:13:08 +00:00
Greg Ward c50b088cfd Add a big comment about cross-platform issues (especially OpenBSD).
This should be turned into a footnote by someone who actually
understands OSS and its relationship to Linux, FreeBSD, OpenBSD, NetBSD,
etc.
2003-05-03 19:45:47 +00:00
Greg Ward bf8f1b55a8 Use TeX quotes -- ``foo'' -- as appropriate.
Remove whitespace around em-dashes.
2003-05-03 19:41:45 +00:00
Greg Ward b4e3319302 Fix various markup errors: use \longprogramopt{} more, and use it
correctly.  (Closes SF #731689.)  Use \emph{} in a few places.
2003-05-03 19:16:36 +00:00
Martin v. Löwis ec31047c0c Use \versionchanged, not \versionadded. 2003-05-03 10:59:13 +00:00
Martin v. Löwis 7829e5661c Patch #731514: Update recursion documentation to mention simple recursion. 2003-05-03 10:57:53 +00:00
Martin v. Löwis e59e2bab8f Patch #711902: Cause pydoc to show data descriptor __doc__ strings. 2003-05-03 09:09:02 +00:00
Fred Drake 8b34e7cc40 - add title attributes to the navigation icons on the navigation bars;
this causes some browsers to offer descriptive tooltips when the
  mouse hovers over the linked icon
- clean up the code in this area
2003-05-03 02:07:22 +00:00
Fred Drake 05404c3d7c add link types for the remaining links in the navigation panels 2003-05-02 20:30:18 +00:00
Fred Drake bf8ec3e035 - add link relationships to some of the links in the navigation panels
- implement custom_REL_hook() so LaTeX2HTML uses currently recommended
  link types; those work fine with tools like the Mozilla Site
  Navigation Bar
2003-05-02 20:18:01 +00:00
Raymond Hettinger 341deb74e7 The previous made the stop argument optional.
It is better to be explicit and just allow stop to be None.
2003-05-02 19:44:20 +00:00
Raymond Hettinger 14ef54cd83 SF bug #730685: itertools.islice stop argument is not optional
* itertools.islice() stop argument did not perform as documented.
* beefed-up test suite
2003-05-02 19:04:37 +00:00
Fred Drake 98b2576424 Avoid extraneous blank line generated in the middle of the document
head.
2003-05-02 18:21:22 +00:00
Fred Drake f06b90534b Remove section number from the title for use in the
<meta name='description' ...> element in the document head.
2003-05-02 18:08:16 +00:00
Fred Drake 90fc0b356f At the site of an indexed reference to print, point to the relevant
documentation.  Closes SF bug #723136.
2003-04-30 16:44:36 +00:00
Fred Drake b876bcc561 work around mostly-minor formatting problems; the encodings.idna
example still doesn't come out quite right: a bug in the formatting
tools
2003-04-30 15:03:46 +00:00
Fred Drake d4be747e1e - comment out \moduleauthor that broke formatting until the formatting
tools can be fixed; added XXX comment
- general markup fixes
2003-04-30 15:02:07 +00:00
Fred Drake c95628e3f2 - clean up some extra punctuation hidden in indexing markup
- fix a typo and one markup nit
- normalize whitespace
2003-04-29 13:56:40 +00:00
Fred Drake 83c19ee06b Clarify that the timeout argument to read_until() is in seconds. 2003-04-29 13:39:05 +00:00
Raymond Hettinger 6e887bb05f SF bug #729096: getopt online documentation example improvement
A newbie found it difficult to translate the exampe into a
case that used only short options or long options but not both.
He tried to shorten the tuple search but forgot the trailing comma,
The appropriate pattern is an equality check.

Revised the example to point him in the right direction.

Backport candidate.
2003-04-29 04:35:36 +00:00
Brett Cannon a2f8737faf Add comment that urlopen opens local files without universal newlines 2003-04-29 04:11:12 +00:00
Tim Peters a1af767c4d Reworded fabs() for consistency with the others. Noted that all
return values are floats.
2003-04-28 21:32:03 +00:00
Tim Peters a390c6e194 walk() docs: Emphasize that the recursive-delete example is dangerous. 2003-04-28 19:15:10 +00:00
Tim Peters 5501b5e3d7 SF bug 728097: tmpnam problems on windows 2.3b, breaks test.test_os.
tmpnam() appears essentially useless on Windows, and it finally broke
the test for Irmen de Jong.  Read the long new comment in test_tmpnam()
for details.  Since the MS implementation is insane, it might be good
if we supplied a different implementation.

Bugfix candidate.
2003-04-28 03:13:03 +00:00
Tim Peters bf89b3a1f7 walk() docs: Worked "walking" into the description and the text. Added
a brief example where bottom-up walking is essential.
2003-04-28 02:09:43 +00:00
Tim Peters 965697fc4b Clarified new text about math exceptions.
Bugfix candidate.
2003-04-26 15:11:08 +00:00
Skip Montanaro 5118341530 Add note about platform-specific behavior arising from discussion on bug
711019.
2003-04-26 02:59:00 +00:00
Fred Drake 2f36b3e205 Version updates for Python 2.3. 2003-04-26 00:52:30 +00:00
Fred Drake 9635268ea9 organizational and markup cleansing 2003-04-25 18:02:34 +00:00
Fred Drake c440af5495 Updated information on package metadata to reflect recent additions.
This is a modified form of SF patch #718027 (mostly markup changes).
2003-04-25 16:43:28 +00:00
Fred Drake d198f38505 - add availability statements for some of the new APIs
- lots of general cleanup
2003-04-25 16:16:02 +00:00
Fred Drake 53e5b71bbc Add modified versions of the examples from Sean Reifschneider
(SF patch #545480).
2003-04-25 15:27:33 +00:00
Guido van Rossum b016752d8b Fix a copy-paste error: the paragraph about inet_ntop's use was copied
literally from inet_pton.
2003-04-25 15:26:58 +00:00
Skip Montanaro 5d0136e297 reflect csv's change back to a module. Document the new sniffer api. 2003-04-25 15:14:49 +00:00
Fred Drake 9f48045ec0 Use a simpler \note instead of a "See also" section to refer to the
os.walk() generator.
2003-04-25 15:12:47 +00:00
Neal Norwitz 6eb502f267 Add versionadded for has_ipv6 attribute 2003-04-25 14:53:48 +00:00
Neal Norwitz cabf56f8b4 Fix markup 2003-04-25 14:52:41 +00:00
Fred Drake 2194a4eede markup adjustments 2003-04-25 14:50:06 +00:00
Tim Peters c4e0940042 New generator os.walk() does a bit more than os.path.walk() does, and
seems much easier to use.  Code, docs, NEWS, and additions to test_os.py
(testing this sucker is a bitch!).
2003-04-25 07:11:48 +00:00
Guido van Rossum 47dfa4a89a Patch by Jp Calderone:
- The socket module now provides the functions inet_pton and inet_ntop
  for converting between string and packed representation of IP addresses.
  See SF patch #658327.

This still needs a bit of work in the doc area, because it is not
available on all platforms (especially not on Windows).
2003-04-25 05:48:32 +00:00
Andrew M. Kuchling f8d0c075b2 [Patch #628208] Document the allow_none argument 2003-04-25 00:29:31 +00:00
Skip Montanaro 3bd3c8403a * minor tweaks relating to the package nature of the beast
* added an (incomplete) description of the utils.Sniffer class
2003-04-24 18:47:31 +00:00
Barry Warsaw 50889239c3 Updated a bunch of docs to describe how message ids and strings are
Unicode in GNUTranslations.  Also provide better descriptions of
*gettext() overridden methods, esp. w.r.t. the behavior in the face of
fallbacks.
2003-04-24 18:14:49 +00:00
Andrew M. Kuchling 035272be91 Add some more items 2003-04-24 16:38:20 +00:00
Fred Drake c11076e0da Bump the release information. 2003-04-24 16:37:21 +00:00
Fred Drake d859d470a1 Add cross-references between urllib.urlencode() and cgi.parse_qs[l]().
Closes SF bug #724751.
2003-04-24 16:22:47 +00:00
Raymond Hettinger 024aaa1bfe SF Patch 549151: urllib2 POSTs on redirect
(contributed by John J Lee)
2003-04-24 15:32:12 +00:00
Fred Drake 1d5854fdc4 Note the platform module. 2003-04-24 15:24:46 +00:00
Andrew M. Kuchling 13b4c41748 Mention deprecation of rotor module 2003-04-24 13:23:43 +00:00
Andrew M. Kuchling bbb9a55327 [Patch #679505] Document that this module is deprecated 2003-04-24 13:19:09 +00:00
Brett Cannon 317ad7a5ee Fixed docs for urlretrieve() to match code in the case of opening a local file.
Also some typos and removed trailing whitespace on the lines.
2003-04-24 02:31:14 +00:00
Fred Drake c22b2999f6 fix some markup errors 2003-04-23 20:38:41 +00:00
Skip Montanaro 54a234a566 clarify - restrict version mention to the trunk version 2003-04-23 20:35:14 +00:00
Skip Montanaro 1bd1d858ae added note about character set limitations in passwords. 2003-04-23 20:22:12 +00:00
Thomas Heller 34d7f0927b Document the new functions PyInt_AsUnsignedLongMask(), PyInt_AsUnsignedLongLongMask(),
PyLong_AsUnsignedLongMask(), PyLong_AsUnsignedLongLongMask().
2003-04-23 19:51:05 +00:00
Tim Peters 2d1c846b73 Clarified new fsync() docs. 2003-04-23 19:47:14 +00:00
Thomas Heller 42a1172cf4 Document the new format codes B, H, I, k, K. 2003-04-23 19:27:35 +00:00
Fred Drake 444e434011 Update the package list whenever we build distfiles.
This is used on www.python.org.
2003-04-23 15:04:52 +00:00
Tim Peters 11b2306960 Enable os.fsync() for Windows, mapping it to MS's _commit() there. The
docs here are best-guess:  the MS docs I could find weren't clear, and
some even claimed _commit() has no effect on Win32 systems (which is
easily shown to be false just by trying it).
2003-04-23 02:39:17 +00:00
Raymond Hettinger 863983e8e5 Add comment on performance.
Fix missing right parenthesis.
Add three examples.
2003-04-23 00:09:42 +00:00
Fred Drake 70995830a6 markup corrections 2003-04-22 18:54:53 +00:00
Fred Drake 282be3ab89 - explain the start argument to sum()
- various adjustments to sum() markup and explanation
2003-04-22 14:52:08 +00:00
Fred Drake 03e929e7e0 Fix some markup nits. 2003-04-22 14:30:53 +00:00
Alex Martelli a70b19147f Adding new built-in function sum, with docs and tests. 2003-04-22 08:12:33 +00:00
Gustavo Niemeyer 48f3dcc93e - Changed shlex.split() method to have more useful and
meaningful parameters.
2003-04-20 01:57:03 +00:00
Gustavo Niemeyer cf146d31e7 - Included examples documenting how the lastindex member of
match objects work.
2003-04-20 01:48:59 +00:00
Martin v. Löwis 153c9e493e Patch #553171: Add writeback parameter. Also add protocol parameter. 2003-04-19 20:59:03 +00:00
Guido van Rossum a26854095b - Several methods of nntplib.NNTP have grown an optional file argument
which specifies a file where to divert the command's output
  (already supported by the body() method).  (SF patch #720468)
  Thanks to Terry Carroll.
2003-04-19 18:04:57 +00:00
Andrew M. Kuchling e36b690087 Mention the bz2 module
Various rewrites
2003-04-19 15:38:47 +00:00
Barry Warsaw b05df5796a Added some more documentation to as_string() to make it clear that
it's a convenience only.  Give an example of what to do for more
flexibility.
2003-04-18 23:03:53 +00:00
Martin v. Löwis 338bcbccfa Change email address. 2003-04-18 22:04:34 +00:00
Martin v. Löwis faf71ea5b3 Fix spelling of cedillas. 2003-04-18 21:48:56 +00:00
Martin v. Löwis 07d4fb6f17 Correct methoddesc environments. 2003-04-18 21:48:13 +00:00
Martin v. Löwis 382f078437 Add lib/libstringprep.tex lib/libdocxmlrpc.tex. 2003-04-18 21:45:26 +00:00
Martin v. Löwis 281b2c6211 Patch #536883: SimpleXMLRPCServer auto-docing subclass. 2003-04-18 21:04:39 +00:00
Fred Drake cf6d74aedd - accepted (slightly) modified version of docs for the OptionGroup
class; closes SF patch #697941
- use em-dashes intead of en-dashes
- section references: use a "tie" between the word "section" and the
  section number, use quotation marks around section titles
- other minor markup corrections/cleanups
2003-04-18 15:50:13 +00:00
Martin v. Löwis 2548c730c1 Implement IDNA (Internationalized Domain Names in Applications). 2003-04-18 10:39:54 +00:00
Neal Norwitz 10cf21802d Use True in a few more places.
Use isinstance(somestring, basestring) instead of type() as per PEP 8
2003-04-17 23:09:08 +00:00
Neal Norwitz a6bdf2aef6 Oops, missed updating doc to correct version for split 2003-04-17 23:07:13 +00:00
Fred Drake 30b6e8230b Added documentation for the handle_pi() method, based on SF patch #662464.
Closes SF bug #659188, patch #662464.
2003-04-17 22:36:52 +00:00
Fred Drake aa3b5d2ec5 markup banalities 2003-04-17 21:49:04 +00:00
Gustavo Niemeyer 68d8cef89a Implemented posix-mode parsing support in shlex.py, as dicussed in
mailing list, and in patch #722686.
2003-04-17 21:31:33 +00:00
Raymond Hettinger 2ed6dff796 As discussed on python-dev, revised docs to note that
PyObject_IsTrue() can have an error result.

Also, added missing docs for PyObject_Not().

Will backport.
2003-04-16 17:28:12 +00:00
Neal Norwitz 1475c49211 Add version info for name2codepoint and codepoint2name 2003-04-16 13:21:06 +00:00
Walter Dörwald 5688b7ac3e Add two dictionaries to htmlentitydefs: name2codepoint maps
HTML entity names to Unicode codepoints (as integers).
codepoint2name is the reverse mapping. From SF patch #722017.
2003-04-16 09:46:13 +00:00
Guido van Rossum 0fc8f00252 - pythunrun.c, Py_Finalize(): move the call to _Py_PrintReferences()
even farther down, to just before the call to
  _PyObject_DebugMallocStats().  This required the following changes:

- pystate.c, PyThreadState_GetDict(): changed not to raise an
  exception or issue a fatal error when no current thread state is
  available, but simply return NULL without raising an exception
  (ever).

- object.c, Py_ReprEnter(): when PyThreadState_GetDict() returns NULL,
  don't raise an exception but return 0.  This means that when
  printing a container that's recursive, printing will go on and on
  and on.  But that shouldn't happen in the case we care about (see
  first bullet).

- Updated Misc/NEWS and Doc/api/init.tex to reflect changes to
  PyThreadState_GetDict() definition.
2003-04-15 15:12:39 +00:00
Guido van Rossum 3a3cca5b82 - list.insert(i, x) now interprets negative i as it would be
interpreted by slicing, so negative values count from the end of the
  list.  This was the only place where such an interpretation was not
  placed on a list index.
2003-04-14 20:58:14 +00:00
Andrew M. Kuchling b43f15e1ce Add a name 2003-04-14 18:47:28 +00:00
Andrew M. Kuchling 44c62ef5ee Typo fix 2003-04-14 15:32:18 +00:00
Andrew M. Kuchling d39078ba2d Mention timeit module
Fix error in description of logging package's 'propagate'
Mention default arg to dict.pop()
Link to more module docs
   (I wonder if I should adopt some convention such as linking the first
    mention of all new modules to the LibRef?)
Various text changes
Bump version number and Python version
2003-04-13 21:44:28 +00:00
Andrew M. Kuchling ba887bb04e Use simpler import 2003-04-13 21:13:02 +00:00
Barry Warsaw 125b9b0736 Back out of setting the default charset to iso-8859-1. 2003-04-11 21:28:10 +00:00
Neal Norwitz 06c7b62a83 Fix markup 2003-04-11 18:48:03 +00:00
Barry Warsaw a1ce93f87c From http://mail.python.org/pipermail/i18n-sig/2003-April/001557.html
- Expose NullTranslations and GNUTranslations to __all__

- Set the default charset to iso-8859-1.  It used to be None, which
would cause problems with .ugettext() if the file had no charset
parameter.  Arguably, the po/mo file would be broken, but I still think
iso-8859-1 is a reasonable default.

- Add a "coerce" default argument to GNUTranslations's constructor.  The
reason for this is that in Zope, we want all msgids and msgstrs to be
Unicode.  For the latter, we could use .ugettext() but there isn't
currently a mechanism for Unicode-ifying msgids.

The plan then is that the charset parameter specifies the encoding for
both the msgids and msgstrs, and both are decoded to Unicode when read.
For example, we might encode po files with utf-8. I think the GNU
gettext tools don't care.

Since this could potentially break code [*] that wants to use the
encoded interface .gettext(), the constructor flag is added, defaulting
to False.  Most code I suspect will want to set this to True and use
.ugettext().

- A few other minor changes from the Zope project, including asserting
that a zero-length msgid must have a Project-ID-Version header for it to
be counted as the metadata record.
2003-04-11 18:36:43 +00:00
Jack Jansen bae5c965e8 Moved all the scripting stuff to a separate section, added all the
missing bits (well, all the bits I could think of) and updated the
rest.
2003-04-11 15:35:28 +00:00
Neal Norwitz ffe33b7f24 Attempt to make all the various string *strip methods the same.
* Doc - add doc for when functions were added
 * UserString
 * string object methods
 * string module functions
'chars' is used for the last parameter everywhere.

These changes will be backported, since part of the changes
have already been made, but they were inconsistent.
2003-04-10 22:35:32 +00:00
Neal Norwitz 4efd91713b Add a space after expression to be consistent 2003-04-10 21:51:29 +00:00
Fred Drake 12dd7b12c6 Minor markup adjustments. 2003-04-09 18:15:57 +00:00
Guido van Rossum 6db771871e Try to discourage use of PyObject_Type(). 2003-04-09 18:02:23 +00:00
Andrew M. Kuchling a6b1c75b7a Re-indent example; fix typo 2003-04-09 17:26:38 +00:00
Jack Jansen d5e0a5a08e Created a minimal MacOSX section. 2003-04-09 15:12:38 +00:00
Fred Drake fcd845a7ed Lots of small markup adjustments. 2003-04-09 04:06:37 +00:00
Fred Drake 61a0a73d76 Add dependency information for the hotshot package docs. 2003-04-09 03:25:07 +00:00
Anthony Baxter fda5e27ec9 extra punctuation removed 2003-04-09 03:03:46 +00:00
Fred Drake 567b0a6445 Add dependency information for the timeit module docs. 2003-04-09 02:41:36 +00:00
Skip Montanaro d6e9fe386a + libtimeit 2003-04-09 01:39:06 +00:00
Skip Montanaro ca652746ff doc for timeit module/script - mostly just a recast of Tim's docstring 2003-04-09 01:38:53 +00:00
Fred Drake 2c2068c4d1 Added example of using positional and keyword args with atexit.register().
Based on a suggestion from a reader.
2003-04-08 17:46:53 +00:00
Fred Drake de7ad2caac Markup fix. 2003-04-08 17:37:47 +00:00
Tim Peters 730f5535ba s/referrents/referents/g. Gotta love that referrers remains rife with rs. 2003-04-08 17:17:17 +00:00
Tim Peters 0f81ab6d88 Finished implementing gc.get_referrents(): dealt with error and end
cases, wrote docs, added a test.
2003-04-08 16:39:48 +00:00
Anthony Baxter cb8ed53014 add note suggested by rhettinger about example. 2003-04-07 12:21:56 +00:00
Anthony Baxter b3303efec6 patch [ 698505 ] docs for hotshot module 2003-04-07 12:19:15 +00:00
Fred Drake 2a04623ddd - add the "download_url" field to the pre-2.2.3 metadata compatibility note
- fix some markup nits
2003-03-31 16:23:09 +00:00
Fred Drake 007fadd59d Fix symbol in grammar; this should fix some hyperlinking in the HTML
version.
2003-03-31 14:53:03 +00:00
Martin v. Löwis 24b8881f61 Patch #701395: Correct documentation of PyUnicode_Splitlines. 2003-03-30 16:40:42 +00:00
Martin v. Löwis b9a0f91218 Rename LONG_LONG to PY_LONG_LONG. Fixes #710285. 2003-03-29 10:06:18 +00:00
Ka-Ping Yee bd379e9627 PyWeakref_GetObject returns None (not NULL) when the referent is gone. 2003-03-28 18:07:16 +00:00
Martin v. Löwis 3ae0f7a7cf Replace criterium with criterion. Fixes #705120. 2003-03-27 16:59:38 +00:00
Neal Norwitz 24fcd23eae Back out previous change as discussed on python-checkins 2003-03-22 16:19:52 +00:00
Neal Norwitz 1e942bd3f4 Add lib/mimelib.tex to dependencies 2003-03-22 00:23:04 +00:00
Barry Warsaw bfa893f3ac email is at version 2.5 now 2003-03-21 21:14:48 +00:00
Andrew M. Kuchling a092ba1adc Add PEP 307 section 2003-03-21 18:32:43 +00:00
Andrew M. Kuchling a978e10676 Add PEP305 section 2003-03-21 18:10:12 +00:00
Andrew M. Kuchling c71bb97e2f Update datetime section a bit 2003-03-21 17:23:07 +00:00
Neal Norwitz 0135b65c01 Add new CSV module to doc dependancies 2003-03-21 00:28:30 +00:00
Skip Montanaro 5fbf8362a3 include csv doc section - Fred, you may want to change the location 2003-03-20 23:35:00 +00:00
Skip Montanaro b4a0417e91 new CSV file processing module - see PEP 305 2003-03-20 23:29:12 +00:00
Fred Drake 4cee220ff3 - added example of using a comparison function with list.sort(), and
explained the construction of a [(key, value), ...] list as an
  alternative
- note that support for cmpfunc=None was added in 2.3
2003-03-20 22:17:59 +00:00
Fred Drake 62364ffb80 - apply SF patch #700798: fixes and cleanups for descriptor info
- use a TeX "tie" to prevent word-wrapping in "section x.y"-like text
2003-03-20 18:17:16 +00:00
Skip Montanaro 2a403e8a7e add descriptions of {get,set}defaulttimeout. 2003-03-20 17:58:12 +00:00
Fred Drake 5c7b2487cd - explain what a UNC path is in the makedirs() description, since
they're actually mentioned there
- remove some extraneous paragraph separations
- \versionadded --> \versionchanged in one place
2003-03-20 17:39:38 +00:00
Michael W. Hudson 43ed43bfc1 Take out my (long since disabled) POSIX signal mask handling code.
I'm not going to have the time or energy to get this working x-platform
-- anyone who does is welcome to the code!
2003-03-13 13:56:53 +00:00
Raymond Hettinger 60de2e837f SF bug #699237: Tutorial uses omitted slice indices before explaining them
Moved up the explanation of slice default arguments.
2003-03-12 04:46:52 +00:00
Barry Warsaw 45c3941510 Update the package version number 2003-03-12 03:43:09 +00:00
Barry Warsaw a996d4f137 For email 2.5b1, we no longer add a trailing newline to
MIMEText.__init__()'s _text argument if it doesn't already end in a
newline.  This may be controversial.
2003-03-11 05:03:25 +00:00
Barry Warsaw 52b39f5b47 body_line_iterator() now takes a decode argument. 2003-03-11 04:40:14 +00:00
Barry Warsaw 20ebc37013 Describe what happens when decode=True and the payload has bogus
base64 data.
2003-03-10 16:13:50 +00:00
Greg Ward cd930f5258 openmixer()'s 'mode' parameter has been removed. 2003-03-10 03:18:19 +00:00
Greg Ward f882c77d70 Expand description of ossaudiodev.error exception.
Improve descriptions of open(), openmixer().
2003-03-10 03:05:21 +00:00
Greg Ward 3e34f59ce2 Rewrite intro paragraphs and add a "See also" box for the link to the
official OSS docs.

Markup fixes: change \code{} variously to \function{}, \method{}, or
\constant{} as appropriate.
2003-03-10 02:09:51 +00:00
Greg Ward 074472ba98 Fix two unformatted lists: one is now an 'enumerate' environment, the
other a 'tableii'.

Formatting/typo fix.
2003-03-10 00:24:42 +00:00
Greg Ward 41a28e374c Add libossaudiodev.tex. 2003-03-10 00:07:14 +00:00
Greg Ward 33bcd987dd Wrap all paragraphs to 72 columns.
Two spaces between sentences.
Fix em-dashes -- should be "---" not " - ".
Spelling fix.
2003-03-09 23:57:34 +00:00
Greg Ward 620e343c0a Documentation for the ossaudiodev module.
Initial revision supplied by Nicholas FitzRoy-Dale <wzdd@lardcave.net>
(emailed to me [gward@python.net] 2003-03-08 23:37 +1100).
2003-03-09 23:34:52 +00:00
Raymond Hettinger 5284b4474e Add contributor name. 2003-03-09 07:19:38 +00:00
Raymond Hettinger 42182ebaf6 SF 698520: Iterator for urllib.URLOpener
Contributed by Brett Cannon.
2003-03-09 05:33:33 +00:00
Skip Montanaro 959c7727f4 Add a little more verbiage about the bsddb module/package change. It's
clear from recent discussions on c.l.py that people are a bit confused about
the differences between the old bsddb, the new bssdb, the bsddb3/PyBSDDB
package and changes to file formats.  Tried to clarify the issues.
2003-03-07 15:45:15 +00:00
Fred Drake 9e1595e6e4 Minor clarification about the ob_size field. 2003-03-07 15:02:03 +00:00
Raymond Hettinger a3e1e4cd79 SF patch #693753: fix for bug 639806: default for dict.pop
(contributed by Michael Stone.)
2003-03-06 23:54:28 +00:00
Neal Norwitz 1930949a8a Fix SF bug #697256, PyMarshal_WriteShortToFile() documented, but not implemented
Remove prototype and doc.  Backport candidate.
2003-03-06 22:04:24 +00:00
Barry Warsaw 1a2c37316b Describe Charset.__repr__(). 2003-03-06 06:07:34 +00:00
Barry Warsaw f32e313914 Describe the new Header.encode() argument "splitchars". 2003-03-06 06:06:54 +00:00
Martin v. Löwis 73d538b9c6 Always initialize Py_FileSystemDefaultEncoding on Unix in Py_Initialize,
and not as a side effect of setlocale. Expose it as sys.getfilesystemencoding.
Adjust test case.
2003-03-05 15:13:47 +00:00
Michael W. Hudson 9c20615d4f Back in June in revision 1.98 Steve (accidentally, presumably) wiped
out a month's worth of checkins to libstdtypes.tex (including my
extended slice docs).

I think this checkin merges them all back in, but if you make one of
these checkins:

    revision 1.97
    date: 2002/06/14 00:27:13;  author: nnorwitz
    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.
    ----------------------------
    revision 1.95
    date: 2002/05/22 20:39:43;  author: bwarsaw
    Jack's documentation for the U mode character on the file()
    constructor, vetted by Barry.
    ----------------------------
    revision 1.94
    date: 2002/05/21 18:19:15;  author: rhettinger
    Patch 543387.  Document deprecation of complex %, //,and divmod().
    ----------------------------
    revision 1.93
    date: 2002/05/15 15:45:25;  author: rhettinger
    Added missing index entries for mapping methods.  Closes patch
    #548693.

some checking may be in order.
2003-03-05 14:42:09 +00:00
Michael W. Hudson 2ab1d08f90 I thought it was common practice to check things compiled before
checking them in?  Oh well, this fixes various obvious mistakes and
changes a subsubsubsection (which doesn't exist) into a subsubsection
(which does).  I'm not sure this matches the intent, but it seems to
read OK on a quick skim.
2003-03-05 14:20:58 +00:00
Andrew M. Kuchling 55fa3bb250 Point e-mail address at the SIG 2003-03-04 19:36:11 +00:00
Andrew M. Kuchling 69700ef573 Weaken recommendation of Friedl book; fix reference 2003-03-04 14:17:05 +00:00
Andrew M. Kuchling 02a0b3b81a [bug #692016] update description of {m,n} modifier; you can omit the lower bound 2003-03-04 14:12:24 +00:00
Andrew M. Kuchling 85f3227a74 [bug #696771] Remove misleading parenthetical aside 2003-03-04 14:07:51 +00:00
Just van Rossum 96b1c903f5 Patch #683592 revisited, after discussions with MvL:
- Implement the behavior as specified in PEP 277, meaning os.listdir()
  will only return unicode strings if it is _called_ with a unicode
  argument.
- And then return only unicode, don't attempt to convert to ASCII.
- Don't switch on Py_FileSystemDefaultEncoding, but simply use the
  default encoding if Py_FileSystemDefaultEncoding is NULL. This means
  os.listdir() can now raise UnicodeDecodeError if the default encoding
  can't represent the directory entry. (This seems better than silcencing
  the error and fall back to a byte string.)
- Attempted to decribe the above in Doc/lib/libos.tex.
- Reworded the Misc/NEWS items to reflect the current situation.

This checkin also fixes bug #696261, which was due to os.listdir() not
using Py_FileSystemDefaultEncoding, like all file system calls are
supposed to.
2003-03-03 17:32:15 +00:00
Michael W. Hudson f008998668 Fix bug
[ 555817 ] Flawed fcntl.ioctl implementation.

with my patch that allows for an array to be mutated when passed
as the buffer argument to ioctl() (details complicated by
backwards compatibility considerations -- read the docs!).
2003-03-03 12:29:42 +00:00
Guido van Rossum 41bcbe3050 Commit MvL's doc patch for SF bug #221327. This adds an example of
calling into Python from a C thread.
2003-03-02 13:17:20 +00:00
Andrew M. Kuchling 563389fdee Add updates for alpha2 2003-03-02 02:31:58 +00:00
Andrew M. Kuchling 41c3e00851 Expand itertools paragraph 2003-03-02 02:13:52 +00:00
Guido van Rossum 46d3dc37e4 - New function sys.exc_clear() clears the current exception. This is
rarely needed, but can sometimes be useful to release objects
  referenced by the traceback held in sys.exc_info()[2].  (SF patch
  #693195.)  Thanks to Kevin Jacobs!
2003-03-01 03:20:41 +00:00
Guido van Rossum d41eea05f4 SF doc patch #692001, properties and __getattribute__. I added some
stuff, and changed 'property' to 'descriptor'.
2003-02-28 14:11:45 +00:00
Andrew M. Kuchling c61402ba26 Update PyPI link 2003-02-26 19:00:52 +00:00
Andrew M. Kuchling b6b4613ae4 [Bug #693474, reported by Stuart Bishop]
Fix errors in the list of setup() arguments
2003-02-26 18:58:46 +00:00
Jack Jansen 5860dab401 Documented linkmodel and WMAvailable(). 2003-02-24 11:02:36 +00:00
Neal Norwitz 7aba3d471f Fix SF bug #691276, shutil.copytree documentation bug 2003-02-23 21:36:47 +00:00
Raymond Hettinger 61fe64d5de User requested changes to the itertools module.
Subsumed times() into repeat().
Added cycle() and chain().
2003-02-23 04:40:07 +00:00
Michael W. Hudson f5dd753f4d I'm am the PyPy sprint waiting for a Grand Renaming so I killed a few
seconds making the doc for get_completer marginally less minimal :)
2003-02-21 20:11:09 +00:00
Neal Norwitz b7d1d3cf23 Add some minimal doc for get_completer added for patch 676342 2003-02-21 18:57:05 +00:00
Raymond Hettinger 1b56de05d5 Fill in missing table entries. 2003-02-21 05:42:13 +00:00
Raymond Hettinger a97e4f3a49 SF bug #685775: turtle circle() documentation error 2003-02-21 03:14:08 +00:00
Raymond Hettinger 3004b090ad SF bug #690377: Dud footnote reference in distutils docs 2003-02-21 02:47:09 +00:00
Raymond Hettinger 1b18ba49ab Markup and nits. 2003-02-21 01:45:34 +00:00
Neal Norwitz d08baa9504 Add some notes about HIGHEST_PROTOCOL. 2003-02-21 00:26:33 +00:00
Fred Drake cade71387e Added a note about the new itertools module. (Omission noted by
Gerrit Holl in email to python-docs.)
2003-02-19 16:08:08 +00:00
Andrew M. Kuchling 3749507296 logging.warn() renamed to warning() 2003-02-19 13:46:18 +00:00
Fred Drake 7f90c7fcb3 Bump version number. 2003-02-18 22:11:58 +00:00
Neal Norwitz 6fa635df7a SF patch #687683, Patches to logging (updates from Vinay)
Mostly rename WARN -> WARNING
Other misc tweaks
Update tests (not in original patch)
2003-02-18 14:20:07 +00:00
Andrew M. Kuchling d87eeb9477 Add two acks; bump version number 2003-02-18 00:56:56 +00:00
Andrew M. Kuchling 7ee9b51ba5 [Bug #688261] Fix optparse example and output 2003-02-18 00:48:23 +00:00
Andrew M. Kuchling acddabc6ec [Bug #683416] Make PEP263 coverage a bit more explicit, and add it to the
porting section
2003-02-18 00:43:24 +00:00
Neal Norwitz f927f14eda Fix SF bug #687655, String formatting conversions misleading 2003-02-17 18:57:06 +00:00
Skip Montanaro 117910dc44 Migrate definitions of several platform-dependent path-related variables
into the relevant path modules.  See patch #686397.
2003-02-14 19:35:31 +00:00
Fred Drake 002a5de202 extsep description:
- avoid "e.g." in text
- record version information
(should be backported)
2003-02-14 06:39:37 +00:00
Skip Montanaro 47e46e2347 add missing description of os.extsep 2003-02-14 05:45:31 +00:00
Raymond Hettinger 2835e37be5 SF bug #663701: sets module review
Renamed hook methods to use the double underscore convention.
2003-02-14 03:42:11 +00:00
Raymond Hettinger e544f6f682 SF bug #663701. The caret wasn't printing well in the PDF documentation. 2003-02-14 01:49:09 +00:00
Neal Norwitz d8d2cf476e Remove deps on mac doc files which have been removed 2003-02-14 01:45:53 +00:00
Skip Montanaro 15f742dbac first cut at a shell script to view a single section from the library
reference manual
2003-02-13 18:30:08 +00:00
Neal Norwitz 12d31e2e9d Try to doc the new pickle details being implemented as part of PEP 307.
Needs review.
2003-02-13 03:12:48 +00:00
Neal Norwitz 2294c0d4ec Cleanup from patch #683257:
Add missing INCREFs and re-indent returns to be consistent.
 Add \n\ for lines in docstring
 Add a pathetic test
 Add docs
2003-02-12 23:02:21 +00:00
Jack Jansen 7aeba45b84 Updated the Mac documentation to the current state of affairs. 2003-02-12 09:58:33 +00:00
Gustavo Niemeyer a33d0aa693 Unparenting BZ2File, as discussed in SF patch #661796.
* Modules/bz2module.c
  (BZ2FileObject): Now the structure includes a pointer to a file object,
   instead of "inheriting" one. Also, some members were copied from the
   PyFileObject structure to avoid dealing with the internals of that
   structure from outside fileobject.c.

  (Util_GetLine,Util_DropReadAhead,Util_ReadAhead,Util_ReadAheadGetLineSkip,
   BZ2File_write,BZ2File_writelines,BZ2File_init,BZ2File_dealloc,
   BZ2Comp_dealloc,BZ2Decomp_dealloc):
   	These functions were adapted to the change above.

  (BZ2File_seek,BZ2File_close): Use PyObject_CallMethod instead of
   getting the function attribute locally.

  (BZ2File_notsup): Removed, since it's not necessary anymore to overload
   truncate(), and readinto() with dummy functions.

  (BZ2File_methods): Added xreadlines() as an alias to BZ2File_getiter,
   and removed truncate() and readinto().

  (BZ2File_get_newlines,BZ2File_get_closed,BZ2File_get_mode,BZ2File_get_name,
   BZ2File_getset):
   	Implemented getters for "newlines", "mode", and "name".

  (BZ2File_members): Implemented "softspace" member.

  (BZ2File_init): Reworked to create a file instance instead of initializing
   itself as a file subclass. Also, pass "name" object untouched to the
   file constructor, and use PyObject_CallFunction instead of building the
   argument tuple locally.

  (BZ2File_Type): Set tp_new to PyType_GenericNew, tp_members to
   BZ2File_members, and tp_getset to BZ2File_getset.

  (initbz2): Do not set BZ2File_Type.tp_base nor BZ2File_Type.tp_new.


* Doc/lib/libbz2.tex
  Do not mention that BZ2File inherits from the file type.
2003-02-11 18:46:20 +00:00
Neal Norwitz ada859c111 Remove duplicate word (rules) 2003-02-11 14:30:39 +00:00
Michael W. Hudson eb189934ce Fix so it compiles at least.
"make lib" takes a while, doesn't it?
2003-02-11 14:24:13 +00:00
Michael W. Hudson 3e245d800d Add item pertaining to
[ 680429 ] __module__ broken for extension classes
2003-02-11 14:19:56 +00:00
Michael W. Hudson 065f5facea Sundry very picky changes. 2003-02-10 19:24:50 +00:00