Commit Graph

8263 Commits

Author SHA1 Message Date
Andrew M. Kuchling d3aad0199e Point users to the subprocess module in the docs for os.system, os.spawn*, os.popen2, and the popen2 and commands modules 2006-10-27 14:53:41 +00:00
Andrew M. Kuchling 4bc64aaef7 [Bug #1562583] Mention the set_reuse_addr() method 2006-10-27 13:06:25 +00:00
Andrew M. Kuchling 14b0cab5d5 [Bug #1583946] Reword description of server and issuer 2006-10-27 12:50:38 +00:00
Andrew M. Kuchling 514d0cf40e [Bug #1585690] Note that line_num was added in Python 2.5 2006-10-27 12:18:38 +00:00
Andrew M. Kuchling 1192044445 Some wording changes and markup fixes 2006-10-27 11:37:01 +00:00
Andrew M. Kuchling 2c184e6703 Add item 2006-10-27 11:36:41 +00:00
Andrew M. Kuchling b501a7e67b Set svn:keywords property 2006-10-27 11:33:29 +00:00
Martin v. Löwis ee82c0e6b7 Patch #1567274: Support SMTP over TLS. 2006-10-27 07:13:28 +00:00
Andrew M. Kuchling acde6102c4 [Bug #1579796] Wrong syntax for PyDateTime_IMPORT in documentation. Reported by David Faure. 2006-10-26 19:10:46 +00:00
Ronald Oussoren 10168f25ad Patch #1580674: with this patch os.readlink uses the filesystem encoding to
decode unicode objects and returns an unicode object when the argument is one.
2006-10-22 10:45:18 +00:00
Andrew M. Kuchling 8a7a9cf507 [Bug #1576348] Fix typo in example 2006-10-19 21:55:55 +00:00
Martin v. Löwis 827ee4411f Mention the bdist_msi module. Will backport to 2.5. 2006-10-15 14:30:38 +00:00
Brett Cannon 5a72372329 Clean up the language of a sentence relating to the connect() function and
user-defined datatypes.
2006-10-14 06:36:45 +00:00
Georg Brandl a9969a6460 Small grammar fix, thanks Sjoerd. 2006-10-12 11:59:27 +00:00
Georg Brandl 6840fcd800 Bug #1560114: the Mac filesystem does have accurate information
about the case of filenames.
2006-10-12 11:46:57 +00:00
Georg Brandl 10f0f691d3 Add a note to fpectl docs that it's not built by default
(bug #1556261).
2006-10-12 11:41:11 +00:00
Georg Brandl 7d74a0e287 Bug #1546628: add a note about urlparse.urljoin() and absolute paths. 2006-10-12 11:14:40 +00:00
Georg Brandl a4c8e32a1f Bug #1565919: document set types in the Language Reference. 2006-10-12 08:22:53 +00:00
Georg Brandl fc8375748a Bug #1575746: fix typo in property() docs. 2006-10-12 07:38:04 +00:00
Skip Montanaro fe6e46d42a Note that the excel_tab class is registered as the "excel-tab" dialect.
Fixes 1572471.  Make a similar change for the excel class and clean up
references to the Dialects and Formatting Parameters section in a few
places.
2006-10-07 11:05:02 +00:00
Andrew M. Kuchling c536a64b89 Case fix 2006-10-06 10:41:01 +00:00
Fred Drake 3c108b0e44 - update links
- remove Sleepycat name now that they have been bought
2006-10-06 00:03:45 +00:00
Brett Cannon 710513ef83 Clarify what "re-initialization" means for init_builtin() and init_dynamic().
Also remove warning about re-initialization as possibly raising an execption as
both call _PyImport_FindExtension() which pulls any module that was already
imported from the Python process' extension cache and just copies the __dict__
into the module stored in sys.modules.
2006-10-05 22:02:31 +00:00
Vinay Sajip f4686f995e Documentation clarified to mention optional parameters. 2006-10-03 18:20:26 +00:00
Vinay Sajip cfbb7df4b0 Documentation omitted the additional parameter to LogRecord.__init__ which was added in 2.5. (See SF #1569622). 2006-10-03 18:02:37 +00:00
Georg Brandl 44a7b3a765 Bug #1546052: clarify that PyString_FromString(AndSize) copies the
string pointed to by its parameter.
2006-09-30 12:02:57 +00:00
Georg Brandl fb25773862 Bug #1566663: remove obsolete example from datetime docs. 2006-09-30 09:06:45 +00:00
Georg Brandl 21d994390c Bug #1567375: a minor logical glitch in example description. 2006-09-30 07:24:48 +00:00
George Yoshida 5cee720aa6 SF bug #1567976 : fix typo
Will backport to 2.5.
2006-09-30 05:14:02 +00:00
Andrew M. Kuchling 656aee7c44 Make examples do error checking on Py_InitModule 2006-09-27 19:23:05 +00:00
Neal Norwitz 9356e11223 SF Bug #1563963, add missing word and cleanup first sentance 2006-09-23 18:11:58 +00:00
Fred Drake 62e955ad13 add boilerplate "What's New" document so the docs will build 2006-09-23 00:26:31 +00:00
Fred Drake 13782a3359 revise explanation of returns_unicode to reflect bool values
and to include the default value
(merged from release25-maint revision 51890)
2006-09-15 16:11:27 +00:00
Fred Drake a58f123602 - fix module name in links in formatted documentation
- minor markup cleanup
(forward-ported from release25-maint revision 51888)
2006-09-15 15:18:04 +00:00
Georg Brandl c9ded90368 Correct elementtree module index entry. 2006-09-15 05:22:24 +00:00
Ka-Ping Yee cdf6afde1a Fix grammar errors and improve clarity. 2006-09-15 00:34:19 +00:00
Andrew M. Kuchling ab856873f1 More wordsmithing 2006-09-12 21:21:51 +00:00
Andrew M. Kuchling 32cec80b02 Some editing, markup fixes 2006-09-12 21:09:02 +00:00
Andrew M. Kuchling abd5520cff Markup typo fix 2006-09-12 20:50:23 +00:00
Andrew M. Kuchling af57f6065f Fix typo in example 2006-09-08 14:05:10 +00:00
Andrew M. Kuchling 6d75567238 Use native SQLite types 2006-09-08 14:03:01 +00:00
Andrew M. Kuchling 3d1839f541 Use native SQLite types 2006-09-08 14:02:45 +00:00
Andrew M. Kuchling 2b46434109 Explain SQLite a bit more clearly 2006-09-08 13:36:36 +00:00
Andrew M. Kuchling 7f295de9a3 Explain SQLite a bit more clearly 2006-09-08 13:35:49 +00:00
Andrew M. Kuchling 0449c516d4 Add missing word 2006-09-08 13:25:23 +00:00
Armin Rigo 863f3d1fbf Add a warning notice on top of the generated grammar.txt. 2006-09-07 15:06:00 +00:00
Andrew M. Kuchling a60b60e72e Rearrange example a bit, and show rpartition() when separator is not found 2006-09-05 13:02:40 +00:00
Georg Brandl c48c9e266f Bug #1552618: change docs of dict.has_key() to reflect recommendation
to use "in".
2006-09-05 12:44:58 +00:00
Raymond Hettinger a0c95fa4d8 Fix endcase for str.rpartition() 2006-09-04 15:32:48 +00:00
Nick Coghlan 5a901c62cc Typo fix for decimal docs 2006-09-03 01:06:07 +00:00
Nick Coghlan f1f42d850f Fix final documentation nits before backporting decimal module fixes to 2.5 2006-09-03 01:02:00 +00:00
Raymond Hettinger 68b6d3b85a Fix documentation nits for decimal context managers. 2006-09-02 17:07:23 +00:00
Nick Coghlan e7877d930c Further corrections to the decimal module context management documentation 2006-09-02 04:04:18 +00:00
Neal Norwitz d7df712ed7 SF #1547931, fix typo (missing and). Will backport to 2.5 2006-09-02 02:43:17 +00:00
Georg Brandl f29882d8e7 evalfile() should be execfile(). 2006-09-01 22:30:52 +00:00
Fred Drake eef345aa97 - SF patch #1550263: Enhance and correct unittest docs
- various minor cleanups for improved consistency
2006-09-01 03:57:19 +00:00
Nick Coghlan 8b6999b4c5 Fix the wrongheaded implementation of context management in the decimal module and add unit tests. (python-dev discussion is ongoing regarding what we do about Python 2.5) 2006-08-31 12:00:43 +00:00
Armin Rigo f580b104a4 Doc fix: hashlib objects don't always return a digest of 16 bytes.
Backport candidate for 2.5.
2006-08-31 08:51:06 +00:00
Andrew M. Kuchling 2214507e74 Move functional howto into trunk 2006-08-22 23:13:43 +00:00
Anthony Baxter c85578725b patch for documentation for recent uuid changes (from ping) 2006-08-22 07:36:59 +00:00
Andrew M. Kuchling c458433850 Minor edits 2006-08-18 13:57:13 +00:00
Georg Brandl e7c9bad93d Typo in tp_clear docs. 2006-08-18 07:35:47 +00:00
Georg Brandl 648c110671 Bug #1541682: Fix example in the "Refcount details" API docs.
Additionally, remove a faulty example showing PySequence_SetItem applied
to a newly created list object and add notes that this isn't a good idea.
2006-08-18 07:27:59 +00:00
Neal Norwitz b671c9309a More post-release wibble 2006-08-18 04:01:38 +00:00
Thomas Heller f5af05a211 Tutorial:
Clarify somewhat how parameters are passed to functions
    (especially explain what integer means).

    Correct the table - Python integers and longs can both be used.
    Further clarification to the table comparing ctypes types, Python
    types, and C types.

Reference:

    Replace integer by C ``int`` where it makes sense.
2006-08-16 18:02:11 +00:00
Andrew M. Kuchling 213e764d38 Update bug/patch counts 2006-08-16 14:18:23 +00:00
Andrew M. Kuchling ddf37888b8 Link to docs; remove an XXX comment 2006-08-16 13:51:32 +00:00
Andrew M. Kuchling 115ea43bff Bump document version to 1.0; remove pystone paragraph 2006-08-16 13:41:52 +00:00
Andrew M. Kuchling efd68c789e Add UnicodeWarning 2006-08-16 13:22:20 +00:00
Anthony Baxter b409666e8c preparing for 2.5c1 2006-08-16 03:42:26 +00:00
Georg Brandl 4873fb2bac Improve markup in PyUnicode_RichCompare. 2006-08-14 12:36:06 +00:00
Marc-André Lemburg 040f76b79c Slightly revised version of patch #1538956:
Replace UnicodeDecodeErrors raised during == and !=
compares of Unicode and other objects with a new
UnicodeWarning.

All other comparisons continue to raise exceptions.
Exceptions other than UnicodeDecodeErrors are also left
untouched.
2006-08-14 10:55:19 +00:00
Neal Norwitz bfa5f0bb5d SF bug #1539336, distutils example code missing 2006-08-13 00:20:49 +00:00
Neal Norwitz 8a87f5d37e Patch #1538606, Patch to fix __index__() clipping.
I modified this patch some by fixing style, some error checking, and adding
XXX comments.  This patch requires review and some changes are to be expected.
I'm checking in now to get the greatest possible review and establish a
baseline for moving forward.  I don't want this to hold up release if possible.
2006-08-12 17:03:09 +00:00
Tim Peters 4643c2fda1 Followup to bug #1069160.
PyThreadState_SetAsyncExc():  internal correctness changes wrt
refcount safety and deadlock avoidance.  Also added a basic test
case (relying on ctypes) and repaired the docs.
2006-08-10 22:45:34 +00:00
Andrew M. Kuchling 98c048041d Reindent code 2006-08-09 14:06:19 +00:00
Andrew M. Kuchling 58aa6f70a1 Add missing 'self' parameters 2006-08-09 14:05:35 +00:00
Andrew M. Kuchling 13300f2bfa [Patch #1534027] Add notes on locale module changes 2006-08-09 13:57:05 +00:00
Andrew M. Kuchling b71366081f [Bug #1536021] Mention __hash__ change 2006-08-09 13:03:41 +00:00
Martin v. Löwis ab2f8f7bd5 __hash__ may now return long int; the final hash
value is obtained by invoking hash on the long int.
Fixes #1536021.
2006-08-09 07:57:39 +00:00
Georg Brandl 7572f0322a ``str`` is now the same object as ``types.StringType``. 2006-08-08 20:48:10 +00:00
Georg Brandl 7f719c5edf Bug #1536660: separate two words. 2006-08-08 20:13:13 +00:00
Georg Brandl 6c223fe796 Bug #1536828: typo: TypeType should have been StringType. 2006-08-08 20:11:22 +00:00
Andrew M. Kuchling 4f71b55040 Bump version number 2006-08-08 19:00:34 +00:00
Andrew M. Kuchling a9771307b5 'Other changes' section now has only one item; move the item elsewhere and remove the section 2006-08-08 19:00:14 +00:00
Andrew M. Kuchling 88eb45fa1e Move obmalloc item into C API section 2006-08-08 18:56:08 +00:00
Andrew M. Kuchling 30c0d1d174 Reword paragraph to clarify 2006-08-08 18:50:14 +00:00
Georg Brandl 212b587a52 Patch #1534922: correct and enhance unittest docs. 2006-08-05 06:10:54 +00:00
Andrew M. Kuchling f4152c3215 Fix mangled sentence 2006-08-04 21:10:03 +00:00
Gregory P. Smith d856ce0a1f fix typos 2006-08-04 05:17:47 +00:00
Thomas Heller 5c387f2e5d Fix a mistake. 2006-08-02 12:00:13 +00:00
Thomas Heller 6a0ce407fb A few nore words about what ctypes does.
Document that using the wrong calling convention can also raise
'ValueError: Procedure called with the wrong number of arguments'.
2006-08-02 11:35:31 +00:00
Anthony Baxter 5d32a9f188 pre-release machinations 2006-08-02 07:43:09 +00:00
Andrew M. Kuchling b7697a50fb [Bug #848556] Remove \d* from second alternative to avoid exponential case when repeating match 2006-07-31 16:22:05 +00:00
Andrew M. Kuchling aa95fdb783 [Bug #1514540] Instead of putting the standard types in a section, put them in a chapter of their own. This means string methods will now show up in the ToC. (Should the types come before or after the functions+exceptions+constants chapter? I've put them after, for now.) 2006-07-31 16:10:24 +00:00
Georg Brandl fbf969928f Fix function name. 2006-07-31 16:00:34 +00:00
Andrew M. Kuchling ec3a89449e Remove reference to notation 2006-07-31 15:23:43 +00:00
Andrew M. Kuchling 17159fe26f Typo fix 2006-07-31 15:22:58 +00:00
Andrew M. Kuchling 04c897a2a9 Mention csv newline changes 2006-07-31 13:18:27 +00:00
Andrew M. Kuchling 4bcfe53e29 Add PyErr_WarnEx() 2006-07-31 12:52:26 +00:00
Andrew M. Kuchling 555ac45b20 Document PyErr_WarnEx. (Bad Neal! No biscuit!)
Is the explanation of the 'stacklevel' parameter clear?  Please feel free
to edit it.

I don't have LaTeX installed on this machine, so haven't verified that the
markup is correct.  Will check tonight, or maybe the automatic doc build will
tell me.
2006-07-31 12:39:05 +00:00
Andrew M. Kuchling 43bae4144b Add refcounts for PyErr_WarnEx 2006-07-31 12:20:24 +00:00
Skip Montanaro 759c185ce0 minor tweaks 2006-07-31 03:11:11 +00:00
Skip Montanaro 08bbccf369 minor tweaks 2006-07-31 03:09:45 +00:00
Andrew McNamara 10183b8e40 Redo the comment about the 2.5 change in quoted-newline handling. 2006-07-31 02:27:48 +00:00
Georg Brandl 5b654ea774 Bug #1531349: right <-> left glitch in __rop__ description. 2006-07-30 20:18:51 +00:00
George Yoshida c7605270b4 Rename struct.pack_to to struct.pack_into as changed in revision 46642. 2006-07-30 16:37:37 +00:00
Georg Brandl e34ac7ce7a Bug #1002398: The documentation for os.path.sameopenfile now correctly
refers to file descriptors, not file objects.
2006-07-30 11:07:23 +00:00
Georg Brandl ad6911bd62 Clarify that __op__ methods must return NotImplemented if they don't support the operation. 2006-07-30 10:53:32 +00:00
Fred Drake 33c3e29fce - remove yet another reference to how commonly Tkinter is (thought to be) used
- fix an internal section reference
2006-07-30 05:55:39 +00:00
Fred Drake 21731118af remove possibly-outdated comment on what GUI toolkit is most commonly used;
it is hard to know whether this is right, and it does not add valuable reference information
at any rate
2006-07-30 05:49:49 +00:00
Fred Drake c3c805e8b2 update information on wxPython, from Robin Dunn 2006-07-30 05:41:28 +00:00
Fred Drake e0d4aecfc2 lots of markup nits, most commonly Unix/unix --> \UNIX 2006-07-30 03:03:43 +00:00
Andrew M. Kuchling ad416d056f [Bug #793553] Correct description of keyword arguments for SSL authentication 2006-07-30 00:37:56 +00:00
Fred Drake d457a97beb markup cleanups 2006-07-29 23:34:57 +00:00
Andrew M. Kuchling 2d5c8e3bb1 Fix case for 'Unix' 2006-07-29 21:30:21 +00:00
Andrew M. Kuchling b9a79c95dc Follow TeX's conventions for hyphens 2006-07-29 21:27:12 +00:00
Fred Drake a650fb3d6f fix minor markup error that introduced extra punctuation 2006-07-29 20:21:25 +00:00
Skip Montanaro abd51a3585 Add a comment to the csv reader documentation that explains why the
treatment of newlines changed in 2.5.  Pulled almost verbatim from a comment
by Andrew McNamara in <http://python.org/sf/1465014>.
2006-07-29 20:06:05 +00:00
Fred Drake 45540b0922 SF bug #1193966: Weakref types documentation misplaced
The information about supporting weakrefs with types defined in C extensions
is moved to the Extending & Embedding manual.  Py_TPFLAGS_HAVE_WEAKREFS is
no longer mentioned since it is part of Py_TPFLAGS_DEFAULT.
2006-07-29 20:04:42 +00:00
Andrew M. Kuchling 9964fdb466 [Patch #1068277] Clarify that os.path.exists() can return False depending on permissions. Fred approved committing this patch in December 2004! 2006-07-29 19:50:37 +00:00
Andrew M. Kuchling a40191c305 [Patch #1490989 from Skip Montanaro] Mention debugging builds in the API documentation. I've changed Skip's patch to point to Misc/SpecialBuilds and fiddled with the markup a bit. 2006-07-29 19:24:04 +00:00
Fred Drake 897afc43ad emphasize and oddball nuance of LaTeX comment syntax 2006-07-29 19:14:10 +00:00
Fred Drake 4a847888a7 document the footnote usage pattern 2006-07-29 19:09:01 +00:00
Fred Drake 84608f0c67 make the reference to older versions of the documentation a link
to the right page on python.org
2006-07-29 18:33:29 +00:00
Andrew M. Kuchling 956597f4ef Reorganize the docs for 'file' and 'open()' after some discussion with Fred.
We want to encourage users to write open() when opening a file, but
open() was described with a single paragraph and
'file' had lots of explanation of the mode and bufsize arguments.

I've shrunk the description of 'file' to cross-reference to the 'File
objects' section, and to open() for an explanation of the arguments.

open() now has all the paragraphs about the mode string.  The bufsize
argument was moved up so that it isn't buried at the end; now there's
1 paragraph on mode, 1 on bufsize, and then 3 more on mode.  Various
other edits and rearrangements were made in the process.

It's probably best to read the final text and not to try to make sense
of the diffs.
2006-07-29 18:14:07 +00:00
Fred Drake fbdeaad069 expunge the xmlcore changes:
41667, 41668 - initial switch to xmlcore
  47044        - mention of xmlcore in What's New
  50687        - mention of xmlcore in the library reference

re-apply xmlcore changes to xml:
  41674        - line ending changes (re-applied manually), directory props
  41677        - add cElementTree wrapper
  41678        - PSF licensing for etree
  41812        - whitespace normalization
  42724        - fix svn:eol-style settings
  43681, 43682 - remove Python version-compatibility cruft from minidom
  46773        - fix encoding of \r\n\t in attr values in saxutils
  47269        - added XMLParser alias for cElementTree compatibility

additional tests were added in Lib/test/test_sax.py that failed with
the xmlcore changes; these relate to SF bugs #1511497, #1513611
2006-07-29 16:56:15 +00:00
Andrew M. Kuchling c032ee939b Set bug/patch count. Take a bow, everyone! 2006-07-29 16:08:40 +00:00
Andrew M. Kuchling e49741d412 [Bug #1528258] Mention that the 'data' argument can be None.
The constructor docs referred the reader to the add_data() method's docs,
but they weren't very helpful.  I've simply copied an earlier explanation
of 'data' that's more useful.
2006-07-29 15:57:08 +00:00
Matt Fleming aab30d0f08 Fix typo 2006-07-29 15:55:30 +00:00
Andrew M. Kuchling 2d20a5fe99 Typo fix 2006-07-29 15:42:46 +00:00
Andrew M. Kuchling b9d7e04880 [Bug #1530382] Document SSL.server(), .issuer() methods 2006-07-29 15:35:21 +00:00
Andrew M. Kuchling 7092f4ce9f [Bug #1519571] Document some missing functions: setup(), title(), done() 2006-07-29 14:42:48 +00:00
Andrew M. Kuchling dafb1e59c9 [Bug #1529157] Mention raw_input() and input(); while I'm at it, reword the description a bit 2006-07-29 14:21:15 +00:00
Andrew M. Kuchling 3ec3f78c8a Reword paragraph to match the order of the subsequent sections 2006-07-29 14:08:15 +00:00
Andrew M. Kuchling 144691cfd8 Update URL 2006-07-29 14:04:47 +00:00
Andrew M. Kuchling 35f64c12d3 Add example 2006-07-29 13:56:48 +00:00
Georg Brandl 9fd21e31b6 Bug #835255: The "closure" argument to new.function() is now documented. 2006-07-29 08:51:21 +00:00
Phillip J. Eby f7575d0cb7 Bug #1529871: The speed enhancement patch #921466 broke Python's compliance
with PEP 302.  This was fixed by adding an ``imp.NullImporter`` type that is
used in ``sys.path_importer_cache`` to cache non-directory paths and avoid
excessive filesystem operations during imports.
2006-07-28 21:12:07 +00:00
Andrew M. Kuchling 39d7739e6c Add example. Should I propagate this example to all the other DBM-ish modules, too? 2006-07-28 12:48:07 +00:00
Andrew M. Kuchling 1d69a7013f Don't overwrite built-in name; add some blank lines for readability 2006-07-28 12:45:55 +00:00
Andrew M. Kuchling bd468103e0 Add example 2006-07-28 12:33:19 +00:00
Andrew M. Kuchling 4036f43cac Add example 2006-07-28 12:32:43 +00:00
Andrew M. Kuchling 984b075978 Typo fix 2006-07-28 12:18:22 +00:00
Andrew M. Kuchling 9d93341489 [Patch #1529811] Correction to description of r|* mode 2006-07-28 12:07:12 +00:00
Tim Peters 750c4420a8 Live with that "the hardware address" is an ill-defined
concept, and that different ways of trying to find "the
hardware address" may return different results.  Certainly
true on both of my Windows boxes, and in different ways
(see whining on python-dev).
2006-07-28 04:51:59 +00:00
Barry Warsaw 00decd7835 Patch #1520294: Support for getset and member descriptors in types.py,
inspect.py, and pydoc.py.  Specifically, this allows for querying the type of
an object against these built-in C types and more importantly, for getting
their docstrings printed in the interactive interpreter's help() function.

This patch includes a new built-in module called _types which provides
definitions of getset and member descriptors for use by the types.py module.
These types are exposed as types.GetSetDescriptorType and
types.MemberDescriptorType.  Query functions are provided as
inspect.isgetsetdescriptor() and inspect.ismemberdescriptor().  The
implementations of these are robust enough to work with Python implementations
other than CPython, which may not have these fundamental types.

The patch also includes documentation and test suite updates.

I commit these changes now under these guiding principles:

1. Silence is assent.  The release manager has not said "no", and of the few
   people that cared enough to respond to the thread, the worst vote was "0".

2. It's easier to ask for forgiveness than permission.

3. It's so dang easy to revert stuff in svn, that you could view this as a
   forcing function. :)

Windows build patches will follow.
2006-07-27 23:43:15 +00:00
Andrew M. Kuchling fc0e61d9b6 Add example 2006-07-27 22:49:54 +00:00
Andrew M. Kuchling 752e28ad9f Add example 2006-07-27 22:49:38 +00:00
Andrew M. Kuchling 4b6d53780d Reword paragraph 2006-07-27 22:40:05 +00:00