diff options
Diffstat (limited to 'Doc/library')
| -rw-r--r-- | Doc/library/cgi.rst | 15 | ||||
| -rw-r--r-- | Doc/library/intro.rst | 5 | ||||
| -rw-r--r-- | Doc/library/re.rst | 49 | ||||
| -rw-r--r-- | Doc/library/stdtypes.rst | 46 | ||||
| -rw-r--r-- | Doc/library/subprocess.rst | 2 | ||||
| -rw-r--r-- | Doc/library/warnings.rst | 2 | ||||
| -rw-r--r-- | Doc/library/webbrowser.rst | 16 | ||||
| -rw-r--r-- | Doc/library/xml.etree.elementtree.rst | 6 |
8 files changed, 77 insertions, 64 deletions
diff --git a/Doc/library/cgi.rst b/Doc/library/cgi.rst index 1e14e4b..58222ea 100644 --- a/Doc/library/cgi.rst +++ b/Doc/library/cgi.rst @@ -91,12 +91,13 @@ form contents from standard input or the environment (depending on the value of various environment variables set according to the CGI standard). Since it may consume standard input, it should be instantiated only once. -The :class:`FieldStorage` instance can be indexed like a Python dictionary, and -also supports the standard dictionary methods :meth:`has_key` and :meth:`keys`. -The built-in :func:`len` is also supported. Form fields containing empty -strings are ignored and do not appear in the dictionary; to keep such values, -provide a true value for the optional *keep_blank_values* keyword parameter when -creating the :class:`FieldStorage` instance. +The :class:`FieldStorage` instance can be indexed like a Python dictionary. +It allows membership testing with the :keyword:`in` operator, and also supports +the standard dictionary method :meth:`keys` and the built-in function +:func:`len`. Form fields containing empty strings are ignored and do not appear +in the dictionary; to keep such values, provide a true value for the optional +*keep_blank_values* keyword parameter when creating the :class:`FieldStorage` +instance. For instance, the following code (which assumes that the :mailheader:`Content-Type` header and blank line have already been printed) @@ -104,7 +105,7 @@ checks that the fields ``name`` and ``addr`` are both set to a non-empty string:: form = cgi.FieldStorage() - if not (form.has_key("name") and form.has_key("addr")): + if "name" not in form or "addr" not in form: print "<H1>Error</H1>" print "Please fill in the name and addr fields." return diff --git a/Doc/library/intro.rst b/Doc/library/intro.rst index 33bdefd..5e5fc80 100644 --- a/Doc/library/intro.rst +++ b/Doc/library/intro.rst @@ -44,8 +44,9 @@ browse the table of contents (in front of the manual), or look for a specific function, module or term in the index (in the back). And finally, if you enjoy learning about random subjects, you choose a random page number (see module :mod:`random`) and read a section or two. Regardless of the order in which you -read the sections of this manual, it helps to start with chapter :ref:`builtin`, -as the remainder of the manual assumes familiarity with this material. +read the sections of this manual, it helps to start with chapter +:ref:`built-in-funcs`, as the remainder of the manual assumes familiarity with +this material. Let the show begin! diff --git a/Doc/library/re.rst b/Doc/library/re.rst index d2c9558..374e750 100644 --- a/Doc/library/re.rst +++ b/Doc/library/re.rst @@ -216,7 +216,7 @@ The special characters are: flags are described in :ref:`contents-of-module-re`.) This is useful if you wish to include the flags as part of the regular expression, instead of passing a *flag* argument to the - :func:`compile` function. + :func:`re.compile` function. Note that the ``(?x)`` flag changes how the expression is parsed. It should be used first in the expression string, or after one or more whitespace characters. @@ -443,9 +443,9 @@ form. result = re.match(pattern, string) - but using :func:`compile` and saving the resulting regular expression object - for reuse is more efficient when the expression will be used several times - in a single program. + but using :func:`re.compile` and saving the resulting regular expression + object for reuse is more efficient when the expression will be used several + times in a single program. .. note:: @@ -532,7 +532,7 @@ form. .. note:: - If you want to locate a match anywhere in *string*, use :meth:`search` + If you want to locate a match anywhere in *string*, use :func:`search` instead. @@ -686,8 +686,8 @@ attributes: .. note:: - If you want to locate a match anywhere in *string*, use :meth:`search` - instead. + If you want to locate a match anywhere in *string*, use + :meth:`~RegexObject.search` instead. The optional second parameter *pos* gives an index in the string where the search is to start; it defaults to ``0``. This is not completely equivalent to @@ -716,7 +716,7 @@ attributes: is different from finding a zero-length match at some point in the string. The optional *pos* and *endpos* parameters have the same meaning as for the - :meth:`match` method. + :meth:`~RegexObject.match` method. .. method:: RegexObject.split(string[, maxsplit=0]) @@ -780,10 +780,10 @@ support the following methods and attributes: .. method:: MatchObject.expand(template) Return the string obtained by doing backslash substitution on the template - string *template*, as done by the :meth:`sub` method. Escapes such as ``\n`` are - converted to the appropriate characters, and numeric backreferences (``\1``, - ``\2``) and named backreferences (``\g<1>``, ``\g<name>``) are replaced by the - contents of the corresponding group. + string *template*, as done by the :meth:`~RegexObject.sub` method. Escapes + such as ``\n`` are converted to the appropriate characters, and numeric + backreferences (``\1``, ``\2``) and named backreferences (``\g<1>``, + ``\g<name>``) are replaced by the contents of the corresponding group. .. method:: MatchObject.group([group1, ...]) @@ -907,16 +907,16 @@ support the following methods and attributes: .. attribute:: MatchObject.pos - The value of *pos* which was passed to the :func:`search` or :func:`match` - method of the :class:`RegexObject`. This is the index into the string at which - the RE engine started looking for a match. + The value of *pos* which was passed to the :meth:`~RegexObject.search` or + :meth:`~RegexObject.match` method of the :class:`RegexObject`. This is the + index into the string at which the RE engine started looking for a match. .. attribute:: MatchObject.endpos - The value of *endpos* which was passed to the :func:`search` or :func:`match` - method of the :class:`RegexObject`. This is the index into the string beyond - which the RE engine will not go. + The value of *endpos* which was passed to the :meth:`~RegexObject.search` or + :meth:`~RegexObject.match` method of the :class:`RegexObject`. This is the + index into the string beyond which the RE engine will not go. .. attribute:: MatchObject.lastindex @@ -936,13 +936,15 @@ support the following methods and attributes: .. attribute:: MatchObject.re - The regular expression object whose :meth:`match` or :meth:`search` method - produced this :class:`MatchObject` instance. + The regular expression object whose :meth:`~RegexObject.match` or + :meth:`~RegexObject.search` method produced this :class:`MatchObject` + instance. .. attribute:: MatchObject.string - The string passed to :func:`match` or :func:`search`. + The string passed to :meth:`~RegexObject.match` or + :meth:`~RegexObject.search`. Examples @@ -987,8 +989,9 @@ To match this with a regular expression, one could use backreferences as such: >>> displaymatch(pair.match("354aa")) # Pair of aces. "<Match: '354aa', groups=('a',)>" -To find out what card the pair consists of, one could use the :func:`group` -method of :class:`MatchObject` in the following manner: +To find out what card the pair consists of, one could use the +:meth:`~MatchObject.group` method of :class:`MatchObject` in the following +manner: .. doctest:: diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst index 57f96a9..2a0a282 100644 --- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -129,7 +129,17 @@ Notes: Comparisons =========== -.. index:: pair: chaining; comparisons +.. index:: + pair: chaining; comparisons + pair: operator; comparison + operator: == + operator: < + operator: <= + operator: > + operator: >= + operator: != + operator: is + operator: is not Comparison operations are supported by all objects. They all have the same priority (which is higher than that of the Boolean operations). Comparisons can @@ -159,17 +169,6 @@ This table summarizes the comparison operations: | ``is not`` | negated object identity | | +------------+-------------------------+-------+ -.. index:: - pair: operator; comparison - operator: == - operator: < - operator: <= - operator: > - operator: >= - operator: != - operator: is - operator: is not - Notes: (1) @@ -262,6 +261,13 @@ part. builtin: long builtin: float builtin: complex + operator: + + operator: - + operator: * + operator: / + operator: // + operator: % + operator: ** Python fully supports mixed arithmetic: when a binary arithmetic operator has operands of different numeric types, the operand with the "narrower" type is @@ -394,7 +400,15 @@ All :class:`numbers.Real` types (:class:`int`, :class:`long`, and Bit-string Operations on Integer Types -------------------------------------- -.. _bit-string-operations: +.. index:: + triple: operations on; integer; types + pair: bit-string; operations + pair: shifting; operations + pair: masking; operations + operator: ^ + operator: & + operator: << + operator: >> Plain and long integer types support additional operations that make sense only for bit-strings. Negative numbers are treated as their 2's complement value @@ -426,12 +440,6 @@ This table lists the bit-string operations sorted in ascending priority: | ``~x`` | the bits of *x* inverted | | +------------+--------------------------------+----------+ -.. index:: - triple: operations on; integer; types - pair: bit-string; operations - pair: shifting; operations - pair: masking; operations - Notes: (1) diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst index bc37d33..a7ef3ff 100644 --- a/Doc/library/subprocess.rst +++ b/Doc/library/subprocess.rst @@ -369,7 +369,7 @@ Replacing :func:`os.system` sts = os.system("mycmd" + " myarg") ==> p = Popen("mycmd" + " myarg", shell=True) - sts = os.waitpid(p.pid, 0) + sts = os.waitpid(p.pid, 0)[1] Notes: diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst index 77fe5ee..3868b74 100644 --- a/Doc/library/warnings.rst +++ b/Doc/library/warnings.rst @@ -204,7 +204,7 @@ check:: fxn() # Verify some things assert len(w) == 1 - assert isinstance(w[-1].category, DeprecationWarning) + assert issubclass(w[-1].category, DeprecationWarning) assert "deprecated" in str(w[-1].message) One can also cause all warnings to be exceptions by using ``error`` instead of diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst index b50bdbe..87b97b1 100644 --- a/Doc/library/webbrowser.rst +++ b/Doc/library/webbrowser.rst @@ -46,14 +46,14 @@ The following exception is defined: The following functions are defined: -.. function:: open(url[, new=0[, autoraise=1]]) +.. function:: open(url[, new=0[, autoraise=True]]) - Display *url* using the default browser. If *new* is 0, the *url* is opened in - the same browser window if possible. If *new* is 1, a new browser window is - opened if possible. If *new* is 2, a new browser page ("tab") is opened if - possible. If *autoraise* is true, the window is raised if possible (note that - under many window managers this will occur regardless of the setting of this - variable). + Display *url* using the default browser. If *new* is 0, the *url* is opened + in the same browser window if possible. If *new* is 1, a new browser window + is opened if possible. If *new* is 2, a new browser page ("tab") is opened + if possible. If *autoraise* is ``True``, the window is raised if possible + (note that under many window managers this will occur regardless of the + setting of this variable). Note that on some platforms, trying to open a filename using this function, may work and start the operating system's associated program. However, this @@ -180,7 +180,7 @@ Browser controllers provide these methods which parallel three of the module-level convenience functions: -.. method:: controller.open(url[, new[, autoraise=1]]) +.. method:: controller.open(url[, new[, autoraise=True]]) Display *url* using the browser handled by this controller. If *new* is 1, a new browser window is opened if possible. If *new* is 2, a new browser page ("tab") diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index 38545c2..e074d55 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -262,9 +262,9 @@ The following methods work on the element's children (subelements). .. method:: Element.getiterator([tag=None]) Creates a tree iterator with the current element as the root. The iterator - iterates over this element and all elements below it that match the given tag. - If tag is ``None`` or ``'*'`` then all elements are iterated over. Returns an - iterable that provides element objects in document (depth first) order. + iterates over this element and all elements below it, in document (depth first) + order. If *tag* is not ``None`` or ``'*'``, only elements whose tag equals + *tag* are returned from the iterator. .. method:: Element.insert(index, element) |