Commit Graph

1534 Commits

Author SHA1 Message Date
Georg Brandl 584265b001 Add more entries to the glossary.
Written by Jeff Wheeler for GHOP.
2007-12-02 14:58:50 +00:00
Georg Brandl b15a8df519 Convert bdb.rst line endings to Unix style. 2007-12-02 14:37:29 +00:00
Georg Brandl fefcd4ec40 Add example to mmap docs.
Written for GHOP by Rafal Rawicki.
2007-12-02 14:34:34 +00:00
Georg Brandl 87983f24cf Add "Using Python on Windows" document, by Robert Lehmann.
Written for GHOP.
2007-12-01 23:12:45 +00:00
Georg Brandl 39bd059e42 Add examples to the ElementTree documentation.
Written by h4wk.cz for GHOP.
2007-12-01 22:42:46 +00:00
Christian Heimes 3e76d9346b Added one more missing versionadded tag 2007-12-01 15:40:22 +00:00
Christian Heimes dfdfaab1c5 Feature #1534
Added PyFloat_GetMax(), PyFloat_GetMin() and PyFloat_GetInfo() to the float API.
Added a dictionary sys.float_info with information about the internal floating point type to the sys module.
2007-12-01 11:20:10 +00:00
Georg Brandl 81ddc1a69b Move lchmod() docs to correct place, and add versionadded tags. 2007-11-30 22:04:45 +00:00
Christian Heimes 3628187b66 Fix for feature request #1528 Add os.fchmod
Georg Brandl has added fchmod() and fchown(). I've contributed lchown but I'm not able to test it on Linux. However it should be available on Mac and some other flavors of Unix.
I've made a quick test of fchmod() and fchown() on my system. They are working as expected.
2007-11-30 21:11:28 +00:00
Georg Brandl 82225b7737 Add more examples to the wsgiref docs.
From GHOP by Josip Dzolonga.
2007-11-29 23:00:03 +00:00
Georg Brandl 430e3620b6 Add examples to the ConfigParser documentation.
Credits go to Thomas Lamb, who wrote this as a task in the GHOP contest.
2007-11-29 17:02:34 +00:00
Georg Brandl 9d83daa03d Fix reference target. 2007-11-29 17:01:20 +00:00
Christian Heimes d7b333779a Added py3kwarning to the documentation of the sys module. 2007-11-28 08:02:36 +00:00
Christian Heimes 28104c58d2 Expose Py_Py3kWarningFlag as sys.py3kwarning as discussed in #1504
Also added a warning.warnpy3k() as convenient method for Python 3.x related deprecation warnings.
2007-11-27 23:16:44 +00:00
Martin v. Löwis c8dfd588c2 Bug #1494: Document that appendChild removes first. 2007-11-24 18:33:40 +00:00
Georg Brandl b67da6ed2b #1735632: add O_NOATIME constant to os module.
Also document a few other O_ constants that were missing from documentation.
2007-11-24 13:56:09 +00:00
Georg Brandl f8b6abd972 #1355: remove mention of PyXML from xml.dom docs. 2007-11-24 11:42:14 +00:00
Georg Brandl 586edab279 #1467: fix documentation for TestResult.add{Error,Failure}. 2007-11-24 11:39:13 +00:00
Georg Brandl 439f250c00 #1344: document that you need to open std{in,out,err} with PIPE if you want
communicate() to work as described.
2007-11-24 11:31:46 +00:00
Facundo Batista c0458830fb Fixed detail in add_type() explanation (issue 1463). 2007-11-19 16:30:24 +00:00
Raymond Hettinger 8465ae8cea Fix signature in example 2007-11-17 01:51:22 +00:00
Raymond Hettinger bc693491eb Add example for use cases requiring default values. 2007-11-15 22:39:34 +00:00
Raymond Hettinger 7c3738e11c Example of multiple replacements. 2007-11-15 03:16:09 +00:00
Raymond Hettinger 213ae014db Fixup example in docs. 2007-11-15 02:58:20 +00:00
Raymond Hettinger 5681cbce81 Small improvement to the implementation of __replace__(). 2007-11-15 02:55:42 +00:00
Raymond Hettinger eeeb9c4445 Accept Issac Morland's suggestion for __replace__ to allow multiple replacements
(suprisingly, this simplifies the signature, improves clarity, and is comparably fast).
Update the docs to reflect a previous change to the function name.
Add an example to the docs showing how to override the default __repr__ method.
2007-11-15 02:44:53 +00:00
Georg Brandl b5b6f3c46e Remove dead link from random docs. 2007-11-14 13:59:09 +00:00
Georg Brandl 07c19eaa20 Fix seealso link to sets docs. Do not merge to Py3k. 2007-11-09 12:31:43 +00:00
Raymond Hettinger 1760c8a017 Add set.isdisjoint() 2007-11-08 02:52:43 +00:00
Raymond Hettinger 12e94200c0 Fix marshal's incorrect handling of subclasses of builtin types (backport candidate). 2007-11-07 01:13:09 +00:00
Gregory P. Smith e1ac4f1930 Fixes Issue 1385: The hmac module now computes the correct hmac when using
hashes with a block size other than 64 bytes (such as sha384 and sha512).
2007-11-06 00:19:03 +00:00
Mark Summerfield 91f9429bc3 Clarified the fact that you can have comments for individual archive
members even though comments to the archive itself aren't currently
supported.
2007-11-05 14:38:50 +00:00
Mark Summerfield aea6e5913b Added cross-references between the various archive file formats. 2007-11-05 09:22:48 +00:00
Georg Brandl 9c466baa01 Fix syntax for versionchanged markup. 2007-11-04 17:43:49 +00:00
Skip Montanaro d469ff1e6a Note change to get_dialect semantics in 2.5. Will backport to 2.5. 2007-11-04 15:56:52 +00:00
Georg Brandl 7c3e79f67f Make "hashable" a glossary entry and clarify docs on __cmp__, __eq__ and __hash__.
I hope the concept of hashability is better understandable now.
Thanks to Tim Hatch for pointing out the flaws here.
2007-11-02 20:06:17 +00:00
Mark Summerfield ac3d429edc Added more file-handling related cross-references. 2007-11-02 08:24:59 +00:00
Georg Brandl 744b32a544 Fix markup glitch. 2007-11-01 20:37:02 +00:00
Georg Brandl 03b15c67ff #1364: os.lstat is available on Windows too, as an alias to os.stat. 2007-11-01 17:19:33 +00:00
Raymond Hettinger 405884cd62 Sets are marshalable. 2007-10-31 22:15:49 +00:00
Raymond Hettinger 84e26b6d5d Clarify the reasons why pickle is almost always better than marshal 2007-10-31 21:57:58 +00:00
Georg Brandl 1a94ec2664 Bug #1287: make os.environ.pop() work as expected. 2007-10-24 21:40:38 +00:00
Neal Norwitz 530042816c Bug #1313, fix typo (wrong variable name) in example. 2007-10-23 05:44:27 +00:00
Travis E. Oliphant 8feafab346 Add phuang patch from Issue 708374 which adds offset parameter to mmap module. 2007-10-23 02:40:56 +00:00
Georg Brandl a739503881 Add :term:s for "new-style class". 2007-10-21 12:15:05 +00:00
Georg Brandl e7a0990113 Add :term:s for iterator. 2007-10-21 12:10:28 +00:00
Georg Brandl cf3fb25932 Add :term: for generators. 2007-10-21 10:52:38 +00:00
Georg Brandl bb75e4e5d2 Unify "file-descriptor" to "file descriptor". 2007-10-21 10:46:24 +00:00
Georg Brandl 5e52db035d Add :term:s for descriptors. 2007-10-21 10:45:46 +00:00
Georg Brandl 5c174bbd84 Add markup to new function descriptions. 2007-10-21 10:32:54 +00:00
Georg Brandl 63fa168326 Unify "byte code" to "bytecode". Also sprinkle :term: markup for it. 2007-10-21 10:24:20 +00:00
Andrew M. Kuchling 529b1a91ce Fix protocol name 2007-10-20 19:25:37 +00:00
Georg Brandl ff27e0cd10 Fix code being interpreted as a target. 2007-10-20 13:22:53 +00:00
Georg Brandl a2ba6ea9aa #1284: "S" means "seen", not unread. 2007-10-19 17:38:49 +00:00
Mark Summerfield 0752d20a34 Added a cross-ref to each other. 2007-10-19 12:48:17 +00:00
Georg Brandl c4ed9713a7 Clarify wording for apply(). 2007-10-19 12:32:39 +00:00
Facundo Batista d97110dd1b Issue 1289, just a typo. 2007-10-18 03:44:48 +00:00
Brett Cannon 1f67a677d0 Remove ``:const:`` notation on None in parameter list. Since the markup is not
rendered for parameters it just showed up as ``:const:`None` `` in the output.
2007-10-16 23:24:06 +00:00
Raymond Hettinger abfd8dff3b More docs, error messages, and tests 2007-10-16 21:28:32 +00:00
Raymond Hettinger 68995867d5 Accept Jim Jewett's api suggestion to use None instead of -1 to indicate unbounded deques. 2007-10-10 00:26:46 +00:00
Raymond Hettinger a48a29947a Eliminate camelcase function name 2007-10-08 21:26:58 +00:00
Raymond Hettinger b6893f2bf8 Missed a line in the docs 2007-10-08 09:56:29 +00:00
Raymond Hettinger 2115bbc4da Add comments to NamedTuple code.
Let the field spec be either a string or a non-string sequence (suggested by Martin Blais with use cases).
Improve the error message in the case of a SyntaxError (caused by a duplicate field name).
2007-10-08 09:14:28 +00:00
Georg Brandl 16fd6c4617 #1123: fix the docs for the str.split(None, sep) case.
Also expand a few other methods' docs, which had more info in the deprecated string module docs.
2007-10-08 07:50:24 +00:00
Fred Drake 06f8067acf move descriptions of ac_(in|out)_buffer_size to the right place
http://bugs.python.org/issue1053
2007-10-05 02:48:32 +00:00
Raymond Hettinger a7fc4b13e0 Add __asdict__() to NamedTuple and refine the docs.
Add maxlen support to deque() and fixup docs.
Partially fix __reduce__().  The None as a third arg was no longer supported.
Still needs work on __reduce__() to handle recursive inputs.
2007-10-05 02:47:07 +00:00
Fred Drake c9b7163da5 wrap lines to <80 characters before fixing errors 2007-10-05 02:46:12 +00:00
Raymond Hettinger 50e90e265f itertools.count() no longer limited to sys.maxint. 2007-10-04 00:20:27 +00:00
Georg Brandl ba2e519082 #1208: document match object's boolean value. 2007-09-27 06:26:58 +00:00
Andrew M. Kuchling 6d407e4d3d Typo fix 2007-09-24 23:46:28 +00:00
Andrew M. Kuchling 9c90635bcb Remove stray odd character; grammar fix 2007-09-24 23:45:51 +00:00
Georg Brandl e4186252b1 #1196: document default radix for int(). 2007-09-24 17:59:28 +00:00
Georg Brandl 97ca58370a Fix typo and double word. 2007-09-24 17:55:47 +00:00
Georg Brandl 4a21268a74 Patch #1181: add os.environ.clear() method. 2007-09-20 17:57:59 +00:00
Georg Brandl efa7d51ee6 #1176: document that string methods don't take keyword args. 2007-09-20 16:45:27 +00:00
Georg Brandl 5d242eef74 alternate -> alternative. 2007-09-20 08:44:59 +00:00
Raymond Hettinger 7268e9d1ff Fit nits 2007-09-20 03:03:43 +00:00
Sean Reifscheider 111c0ea34a issue1172: Documentation of "done" attribute in cgi module. 2007-09-18 23:34:44 +00:00
Raymond Hettinger cbab5949c9 Cleanup docs for NamedTuple. 2007-09-18 22:18:02 +00:00
Raymond Hettinger 2b03d45bb9 Handle corner cased on 0-tuples and 1-tuples. Add verbose option so people can see how it works. 2007-09-18 03:33:19 +00:00
Raymond Hettinger d36a60e1e3 Sync-up named tuples with the latest version of the ASPN recipe.
Allows optional commas in the field-name spec (help when named tuples are used in conjuction with sql queries).
Adds the __fields__ attribute for introspection and to support conversion to dictionary form.
Adds a  __replace__() method similar to str.replace() but using a named field as a target.
Clean-up spelling and presentation in doc-strings.
2007-09-17 00:55:00 +00:00
Bill Janssen 296a59d3be Add support for asyncore server-side SSL support. This requires
adding the 'makefile' method to ssl.SSLSocket, and importing the
requisite fakefile class from socket.py, and making the appropriate
changes to it to make it use the SSL connection.

Added sample HTTPS server to test_ssl.py, and test that uses it.

Change SSL tests to use https://svn.python.org/, instead of
www.sf.net and pop.gmail.com.

Added utility function to ssl module, get_server_certificate,
to wrap up the several things to be done to pull a certificate
from a remote server.
2007-09-16 22:06:00 +00:00
Georg Brandl 7e84c7f4b5 Remove bdb from the "undocumented modules" list. 2007-09-15 16:53:36 +00:00
Facundo Batista e90bc3c81c Some additions (examples and a bit on the tutorial). 2007-09-14 21:29:52 +00:00
Facundo Batista 7c82a3e9c6 Included the new functions, and new descriptions. 2007-09-14 18:58:34 +00:00
Mark Summerfield ddca9f0823 Replaced variable o with obj in operator.rst because o is easy to
confuse.

Added a note about Python 3's collections.Mapping etc., above section
that describes isMappingType() etc.

Added xrefs between os, os.path, fileinput, and open().
2007-09-13 14:54:30 +00:00
Georg Brandl bb07a7df91 Bug #1152: use non-deprecated name in example. 2007-09-12 18:05:57 +00:00
Georg Brandl 0001422a0a New documentation page for the bdb module.
(This doesn't need to be merged to Py3k.)
2007-09-12 18:03:51 +00:00
Bill Janssen 93bf9ce9b7 Fix some documentation bugs. 2007-09-11 02:42:07 +00:00
Bill Janssen 98d19dafd9 More work on SSL support.
* Much expanded test suite:

  All protocols tested against all other protocols.
  All protocols tested with all certificate options.
  Tests for bad key and bad cert.
  Test of STARTTLS functionality.
  Test of RAND_* functions.

* Fixes for threading/malloc bug.

* Issue 1065 fixed:

  sslsocket class renamed to SSLSocket.
  sslerror class renamed to SSLError.
  Function "wrap_socket" now used to wrap an existing socket.

* Issue 1583946 finally fixed:

  Support for subjectAltName added.
  Subject name now returned as proper DN list of RDNs.

* SSLError exported from socket as "sslerror".

* RAND_* functions properly exported from ssl.py.

* Documentation improved:

  Example of how to create a self-signed certificate.
  Better indexing.
2007-09-10 21:51:02 +00:00
Gregory P. Smith e9fef694b4 Change socket.error to inherit from IOError rather than being a stand
alone class.  This addresses the primary concern in

 http://bugs.python.org/issue1706815

python-dev discussion here:

 http://mail.python.org/pipermail/python-dev/2007-July/073749.html

I chose IOError rather than EnvironmentError as the base class since
socket objects are often used as transparent duck typed file objects
in code already prepared to deal with IOError exceptions.

also a minor fix:

 urllib2 - fix a couple places where IOError was raised rather than URLError.
           for better or worse, URLError already inherits from IOError so
           this won't break any existing code.

 test_urllib2net - replace bad ftp urls.
2007-09-09 23:36:46 +00:00
Thomas Heller 2825b2ea44 Add a 'c_longdouble' type to the ctypes module. 2007-09-07 06:32:17 +00:00
Thomas Heller a3a7ddaae5 Fix typo: c_float represents to C float type. 2007-09-06 20:26:20 +00:00
Bill Janssen ffe576dc78 SSL certificate distinguished names should be represented by tuples 2007-09-05 00:46:27 +00:00
Martin v. Löwis 58bd49f5fe Patch #1388440: Add set_completion_display_matches_hook and
get_completion_type to readline.
2007-09-04 13:13:14 +00:00
Mark Summerfield fcb444a8bf Added cross-references plus a note about dict & list shallow copying. 2007-09-04 08:16:15 +00:00
Andrew M. Kuchling 364b841683 Wording change 2007-09-01 21:17:58 +00:00
Andrew M. Kuchling 24e99c43c6 Markup fix 2007-09-01 20:31:59 +00:00
Walter Dörwald 73f83d2bc6 Fix typo. 2007-09-01 18:34:05 +00:00
Walter Dörwald 90014e0a3c Fix wrong function names. 2007-09-01 18:18:09 +00:00
Skip Montanaro 222907da56 Added a note and examples to explain that re.split does not split on an
empty pattern match. (issue 852532).
2007-09-01 17:40:03 +00:00
Georg Brandl 847cae6743 Document sets' ">" and "<" operations (backport from py3k). 2007-09-01 15:49:49 +00:00
Georg Brandl 95b571a084 Fix RST link (backport from Py3k). 2007-09-01 07:51:24 +00:00
Lars Gustäbel 89241a3889 Warn about possible risks when extracting untrusted archives. 2007-08-30 20:24:31 +00:00
Mark Summerfield 7f626f4c34 Added more cross-references. 2007-08-30 15:03:03 +00:00
Georg Brandl f11ed159f3 Stronger urge to convert filenames to str before using them as argument to ZipFile.write(). 2007-08-30 10:09:42 +00:00
Bill Janssen 426ea0a864 This contains a number of things:
1) Improve the documentation of the SSL module, with a fuller
   explanation of certificate usage, another reference, proper
   formatting of this and that.

2) Fix Windows bug in ssl.py, and general bug in sslsocket.close().
   Remove some unused code from ssl.py.  Allow accept() to be called on
   sslsocket sockets.

3) Use try-except-else in import of ssl in socket.py.  Deprecate use of
   socket.ssl().

4) Remove use of socket.ssl() in every library module, except for
   test_socket_ssl.py and test_ssl.py.
2007-08-29 22:35:05 +00:00
Walter Dörwald f0d1c1f3ec Fix title endtag in HTMLCalender.formatyearpage(). Fix documentation for
HTMLCalender.formatyearpage() (there's no themonth parameter).

This fixes issue1046.
2007-08-28 16:38:26 +00:00
Georg Brandl 23b8ddc110 Fix some glitches. 2007-08-28 10:48:18 +00:00
Sean Reifscheider 99cafb99ed Adding basic imputil documentation. 2007-08-28 09:07:54 +00:00
Georg Brandl ae0ee8a473 Document rev. 57574. 2007-08-28 08:29:08 +00:00
Guido van Rossum 8ee23bbe7c Patch 10124 by Bill Janssen, docs for the new ssl code. 2007-08-27 19:11:11 +00:00
Neal Norwitz 9a65c89ec0 Spell check (also americanify behaviour, it's almost 3 times as common) 2007-08-26 01:42:03 +00:00
Guido van Rossum 4f2c3ddca4 Server-side SSL and certificate validation, by Bill Janssen.
While cleaning up Bill's C style, I may have cleaned up some code
he didn't touch as well (in _ssl.c).
2007-08-25 15:08:43 +00:00
Nick Coghlan 3af0e785e7 Revert misguided attempt at fixing incompatibility between -m and -i switches (better fix coming soon) 2007-08-25 04:32:07 +00:00
Georg Brandl d558f67d5d Document new utility functions in test_support. 2007-08-24 18:27:43 +00:00
Georg Brandl 94bda3a586 Bug #1011: fix rfc822.Message.getheader docs. 2007-08-24 17:23:23 +00:00
Georg Brandl 604c121eee Bug #1625381: clarify match vs search introduction. 2007-08-23 21:36:05 +00:00
Georg Brandl b7a837d81b Bug #1734111: document struct.Struct.size. 2007-08-23 21:21:36 +00:00
Georg Brandl 4ad9b8206c Bug #1752332: httplib no longer uses socket.getaddrinfo(). 2007-08-23 21:18:44 +00:00
Georg Brandl a3a68a0db4 Clarify wording a bit. 2007-08-23 20:55:44 +00:00
Georg Brandl 154cc588d3 Bug #1594966: fix misleading usage example 2007-08-23 20:53:28 +00:00
Georg Brandl 3e0f735ce1 Bug #1694833: fix imp.find_module() docs wrt. packages. 2007-08-23 20:50:23 +00:00
Georg Brandl 891f1d339b Bug #1573854: fix docs for sqlite3 cursor rowcount attr. 2007-08-23 20:40:01 +00:00
Georg Brandl 7cf40799ef Bug #1766421: "return code" vs. "status code". 2007-08-23 17:57:05 +00:00
Georg Brandl 4debd55874 Bug #1768121: fix wrong/missing opcode docs. 2007-08-23 17:54:11 +00:00
Georg Brandl c553f42907 Fix stray backticks. 2007-08-19 18:43:50 +00:00
Georg Brandl 3f8fbf0589 Fix PDB command descriptions. 2007-08-18 06:05:56 +00:00
Walter Dörwald 6e39080649 Backport r57105 and r57145 from the py3k branch: UTF-32 codecs. 2007-08-17 16:41:28 +00:00
Matthias Klose f0e291870b - mark the findCaller 2-element tuple/3-element tuple change as new in 2.4 2007-08-16 12:03:44 +00:00
Mark Summerfield 216ad337bd Added a note in each regarding the fact that unicode strings that look the same
may not compare equal (due to the possibility of multiple representations).
2007-08-16 10:09:22 +00:00
Georg Brandl bf863b17f0 Replace "Caveat" paragraphs by .. warning::s. 2007-08-15 19:06:04 +00:00
Georg Brandl 7f758c49fa Mark deprecated modules as such. 2007-08-15 18:41:25 +00:00
Georg Brandl 8ec7f65613 Move the 2.6 reST doc tree in place. 2007-08-15 14:28:01 +00:00