From: <pj...@us...> - 2011-03-14 03:32:52
|
Revision: 7233 http://jython.svn.sourceforge.net/jython/?rev=7233&view=rev Author: pjenvey Date: 2011-03-14 03:32:44 +0000 (Mon, 14 Mar 2011) Log Message: ----------- initial rebuild of docs from python 2.6.4 Modified Paths: -------------- trunk/jython/src/org/python/core/BuiltinDocs.java Modified: trunk/jython/src/org/python/core/BuiltinDocs.java =================================================================== --- trunk/jython/src/org/python/core/BuiltinDocs.java 2011-03-14 03:14:37 UTC (rev 7232) +++ trunk/jython/src/org/python/core/BuiltinDocs.java 2011-03-14 03:32:44 UTC (rev 7233) @@ -15,6 +15,9 @@ public final static String object_doc = "The most base type"; + public final static String object___format___doc = + "default object formatter"; + public final static String object___getattribute___doc = "x.__getattribute__('name') <==> x.name"; @@ -39,10 +42,25 @@ public final static String object___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String object___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String object___str___doc = "x.__str__() <==> str(x)"; + public final static String object___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + // Docs for <type 'type'> + public final static String type___abstractmethods___doc = + ""; + public final static String type___base___doc = "The most base type"; @@ -59,8 +77,9 @@ "argument will be truncated towards zero (this does not include a string\n" + "representation of a floating point number!) When converting a string, use\n" + "the optional base. It is an error to supply a base when converting a\n" + - "non-string. If the argument is outside the integer range a long object\n" + - "will be returned instead."; + "non-string. If base is zero, the proper base is guessed based on the\n" + + "string content. If the argument is outside the integer range a\n" + + "long object will be returned instead."; public final static String type___call___doc = "x.__call__(...) <==> x(...)"; @@ -85,13 +104,17 @@ "argument will be truncated towards zero (this does not include a string\n" + "representation of a floating point number!) When converting a string, use\n" + "the optional base. It is an error to supply a base when converting a\n" + - "non-string. If the argument is outside the integer range a long object\n" + - "will be returned instead."; + "non-string. If base is zero, the proper base is guessed based on the\n" + + "string content. If the argument is outside the integer range a\n" + + "long object will be returned instead."; public final static String type_doc = "type(object) -> the object's type\n" + "type(name, bases, dict) -> a new type"; + public final static String type___eq___doc = + "x.__eq__(y) <==> x==y"; + public final static String type___flags___doc = "int(x[, base]) -> integer\n" + "\n" + @@ -99,18 +122,31 @@ "argument will be truncated towards zero (this does not include a string\n" + "representation of a floating point number!) When converting a string, use\n" + "the optional base. It is an error to supply a base when converting a\n" + - "non-string. If the argument is outside the integer range a long object\n" + - "will be returned instead."; + "non-string. If base is zero, the proper base is guessed based on the\n" + + "string content. If the argument is outside the integer range a\n" + + "long object will be returned instead."; + public final static String type___format___doc = + "default object formatter"; + + public final static String type___ge___doc = + "x.__ge__(y) <==> x>=y"; + public final static String type___getattribute___doc = "x.__getattribute__('name') <==> x.name"; + public final static String type___gt___doc = + "x.__gt__(y) <==> x>y"; + public final static String type___hash___doc = "x.__hash__() <==> hash(x)"; public final static String type___init___doc = "x.__init__(...) initializes x; see x.__class__.__doc__ for signature"; + public final static String type___instancecheck___doc = + ""; + public final static String type___itemsize___doc = "int(x[, base]) -> integer\n" + "\n" + @@ -118,9 +154,16 @@ "argument will be truncated towards zero (this does not include a string\n" + "representation of a floating point number!) When converting a string, use\n" + "the optional base. It is an error to supply a base when converting a\n" + - "non-string. If the argument is outside the integer range a long object\n" + - "will be returned instead."; + "non-string. If base is zero, the proper base is guessed based on the\n" + + "string content. If the argument is outside the integer range a\n" + + "long object will be returned instead."; + public final static String type___le___doc = + "x.__le__(y) <==> x<=y"; + + public final static String type___lt___doc = + "x.__lt__(y) <==> x<y"; + public final static String type___module___doc = "str(object) -> string\n" + "\n" + @@ -139,6 +182,9 @@ "Return a nice string representation of the object.\n" + "If the argument is a string, the return value is the same object."; + public final static String type___ne___doc = + "x.__ne__(y) <==> x!=y"; + public final static String type___new___doc = "T.__new__(S, ...) -> a new object with type S, a subtype of T"; @@ -154,12 +200,27 @@ public final static String type___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String type___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String type___str___doc = "x.__str__() <==> str(x)"; + public final static String type___subclasscheck___doc = + ""; + public final static String type___subclasses___doc = "__subclasses__() -> list of immediate subclasses"; + public final static String type___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String type___weakrefoffset___doc = "int(x[, base]) -> integer\n" + "\n" + @@ -167,8 +228,9 @@ "argument will be truncated towards zero (this does not include a string\n" + "representation of a floating point number!) When converting a string, use\n" + "the optional base. It is an error to supply a base when converting a\n" + - "non-string. If the argument is outside the integer range a long object\n" + - "will be returned instead."; + "non-string. If base is zero, the proper base is guessed based on the\n" + + "string content. If the argument is outside the integer range a\n" + + "long object will be returned instead."; public final static String type_mro_doc = "mro() -> list\n" + @@ -198,6 +260,11 @@ public final static String unicode___eq___doc = "x.__eq__(y) <==> x==y"; + public final static String unicode___format___doc = + "S.__format__(format_spec) -> unicode\n" + + "\n" + + ""; + public final static String unicode___ge___doc = "x.__ge__(y) <==> x>=y"; @@ -212,8 +279,8 @@ public final static String unicode___getslice___doc = "x.__getslice__(i, j) <==> x[i:j]\n" + - " \n" + - " Use of negative indices is not supported."; + " \n" + + " Use of negative indices is not supported."; public final static String unicode___gt___doc = "x.__gt__(y) <==> x>y"; @@ -263,9 +330,29 @@ public final static String unicode___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String unicode___sizeof___doc = + "S.__sizeof__() -> size of S in memory, in bytes\n" + + "\n" + + ""; + public final static String unicode___str___doc = "x.__str__() <==> str(x)"; + public final static String unicode___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + + public final static String unicode__formatter_field_name_split_doc = + ""; + + public final static String unicode__formatter_parser_doc = + ""; + public final static String unicode_capitalize_doc = "S.capitalize() -> unicode\n" + "\n" + @@ -323,11 +410,16 @@ "S.find(sub [,start [,end]]) -> int\n" + "\n" + "Return the lowest index in S where substring sub is found,\n" + - "such that sub is contained within s[start,end]. Optional\n" + + "such that sub is contained within s[start:end]. Optional\n" + "arguments start and end are interpreted as in slice notation.\n" + "\n" + "Return -1 on failure."; + public final static String unicode_format_doc = + "S.format(*args, **kwargs) -> unicode\n" + + "\n" + + ""; + public final static String unicode_index_doc = "S.index(sub [,start [,end]]) -> int\n" + "\n" + @@ -398,7 +490,7 @@ public final static String unicode_ljust_doc = "S.ljust(width[, fillchar]) -> int\n" + "\n" + - "Return S left justified in a Unicode string of length width. Padding is\n" + + "Return S left-justified in a Unicode string of length width. Padding is\n" + "done using the specified fill character (default is a space)."; public final static String unicode_lower_doc = @@ -416,22 +508,22 @@ public final static String unicode_partition_doc = "S.partition(sep) -> (head, sep, tail)\n" + "\n" + - "Searches for the separator sep in S, and returns the part before it,\n" + + "Search for the separator sep in S, and return the part before it,\n" + "the separator itself, and the part after it. If the separator is not\n" + - "found, returns S and two empty strings."; + "found, return S and two empty strings."; public final static String unicode_replace_doc = - "S.replace (old, new[, maxsplit]) -> unicode\n" + + "S.replace (old, new[, count]) -> unicode\n" + "\n" + "Return a copy of S with all occurrences of substring\n" + - "old replaced by new. If the optional argument maxsplit is\n" + - "given, only the first maxsplit occurrences are replaced."; + "old replaced by new. If the optional argument count is\n" + + "given, only the first count occurrences are replaced."; public final static String unicode_rfind_doc = "S.rfind(sub [,start [,end]]) -> int\n" + "\n" + "Return the highest index in S where substring sub is found,\n" + - "such that sub is contained within s[start,end]. Optional\n" + + "such that sub is contained within s[start:end]. Optional\n" + "arguments start and end are interpreted as in slice notation.\n" + "\n" + "Return -1 on failure."; @@ -444,15 +536,15 @@ public final static String unicode_rjust_doc = "S.rjust(width[, fillchar]) -> unicode\n" + "\n" + - "Return S right justified in a Unicode string of length width. Padding is\n" + + "Return S right-justified in a Unicode string of length width. Padding is\n" + "done using the specified fill character (default is a space)."; public final static String unicode_rpartition_doc = "S.rpartition(sep) -> (tail, sep, head)\n" + "\n" + - "Searches for the separator sep in S, starting at the end of S, and returns\n" + + "Search for the separator sep in S, starting at the end of S, and return\n" + "the part before it, the separator itself, and the part after it. If the\n" + - "separator is not found, returns two empty strings and S."; + "separator is not found, return two empty strings and S."; public final static String unicode_rsplit_doc = "S.rsplit([sep [,maxsplit]]) -> list of strings\n" + @@ -475,11 +567,12 @@ "\n" + "Return a list of the words in S, using sep as the\n" + "delimiter string. If maxsplit is given, at most maxsplit\n" + - "splits are done. If sep is not specified or is None,\n" + - "any whitespace string is a separator."; + "splits are done. If sep is not specified or is None, any\n" + + "whitespace string is a separator and empty strings are\n" + + "removed from the result."; public final static String unicode_splitlines_doc = - "S.splitlines([keepends]]) -> list of strings\n" + + "S.splitlines([keepends]) -> list of strings\n" + "\n" + "Return a list of the lines in S, breaking at line boundaries.\n" + "Line breaks are not included in the resulting list unless keepends\n" + @@ -530,8 +623,8 @@ public final static String unicode_zfill_doc = "S.zfill(width) -> unicode\n" + "\n" + - "Pad a numeric string x with zeros on the left, to fill a field\n" + - "of the specified width. The string x is never truncated."; + "Pad a numeric string S with zeros on the left, to fill a field\n" + + "of the specified width. The string S is never truncated."; // Docs for <type 'dict'> public final static String dict___class___doc = @@ -564,6 +657,9 @@ public final static String dict___eq___doc = "x.__eq__(y) <==> x==y"; + public final static String dict___format___doc = + "default object formatter"; + public final static String dict___ge___doc = "x.__ge__(y) <==> x>=y"; @@ -577,7 +673,7 @@ "x.__gt__(y) <==> x>y"; public final static String dict___hash___doc = - "x.__hash__() <==> hash(x)"; + ""; public final static String dict___init___doc = "x.__init__(...) initializes x; see x.__class__.__doc__ for signature"; @@ -615,9 +711,21 @@ public final static String dict___setitem___doc = "x.__setitem__(i, y) <==> x[i]=y"; + public final static String dict___sizeof___doc = + "D.__sizeof__() -> size of D in memory, in bytes"; + public final static String dict___str___doc = "x.__str__() <==> str(x)"; + public final static String dict___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String dict_clear_doc = "D.clear() -> None. Remove all items from D."; @@ -650,19 +758,21 @@ "D.keys() -> list of D's keys"; public final static String dict_pop_doc = - "D.pop(k[,d]) -> v, remove specified key and return the corresponding value\n" + + "D.pop(k[,d]) -> v, remove specified key and return the corresponding value.\n" + "If key is not found, d is returned if given, otherwise KeyError is raised"; public final static String dict_popitem_doc = "D.popitem() -> (k, v), remove and return some (key, value) pair as a\n" + - "2-tuple; but raise KeyError if D is empty"; + "2-tuple; but raise KeyError if D is empty."; public final static String dict_setdefault_doc = "D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D"; public final static String dict_update_doc = - "D.update(E, **F) -> None. Update D from E and F: for k in E: D[k] = E[k]\n" + - "(if E has keys else: for (k, v) in E: D[k] = v) then: for k in F: D[k] = F[k]"; + "D.update(E, **F) -> None. Update D from dict/iterable E and F.\n" + + "If E has a .keys() method, does: for k in E: D[k] = E[k]\n" + + "If E lacks .keys() method, does: for (k, v) in E: D[k] = v\n" + + "In either case, this is followed by: for k in F: D[k] = F[k]"; public final static String dict_values_doc = "D.values() -> list of D's values"; @@ -686,8 +796,8 @@ public final static String list___delslice___doc = "x.__delslice__(i, j) <==> del x[i:j]\n" + - " \n" + - " Use of negative indices is not supported."; + " \n" + + " Use of negative indices is not supported."; public final static String list_doc = "list() -> new list\n" + @@ -696,6 +806,9 @@ public final static String list___eq___doc = "x.__eq__(y) <==> x==y"; + public final static String list___format___doc = + "default object formatter"; + public final static String list___ge___doc = "x.__ge__(y) <==> x>=y"; @@ -707,14 +820,14 @@ public final static String list___getslice___doc = "x.__getslice__(i, j) <==> x[i:j]\n" + - " \n" + - " Use of negative indices is not supported."; + " \n" + + " Use of negative indices is not supported."; public final static String list___gt___doc = "x.__gt__(y) <==> x>y"; public final static String list___hash___doc = - "x.__hash__() <==> hash(x)"; + ""; public final static String list___iadd___doc = "x.__iadd__(y) <==> x+=y"; @@ -769,12 +882,24 @@ public final static String list___setslice___doc = "x.__setslice__(i, j, y) <==> x[i:j]=y\n" + - " \n" + - " Use of negative indices is not supported."; + " \n" + + " Use of negative indices is not supported."; + public final static String list___sizeof___doc = + "L.__sizeof__() -- size of L in memory, in bytes"; + public final static String list___str___doc = "x.__str__() <==> str(x)"; + public final static String list___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String list_append_doc = "L.append(object) -- append object to end"; @@ -785,16 +910,19 @@ "L.extend(iterable) -- extend list by appending elements from the iterable"; public final static String list_index_doc = - "L.index(value, [start, [stop]]) -> integer -- return first index of value"; + "L.index(value, [start, [stop]]) -> integer -- return first index of value.\n" + + "Raises ValueError if the value is not present."; public final static String list_insert_doc = "L.insert(index, object) -- insert object before index"; public final static String list_pop_doc = - "L.pop([index]) -> item -- remove and return item at index (default last)"; + "L.pop([index]) -> item -- remove and return item at index (default last).\n" + + "Raises IndexError if list is empty or index is out of range."; public final static String list_remove_doc = - "L.remove(value) -- remove first occurrence of value"; + "L.remove(value) -- remove first occurrence of value.\n" + + "Raises ValueError if the value is not present."; public final static String list_reverse_doc = "L.reverse() -- reverse *IN PLACE*"; @@ -819,6 +947,9 @@ "\n" + "Create a slice object. This is used for extended slicing (e.g. a[0:10:2])."; + public final static String slice___format___doc = + "default object formatter"; + public final static String slice___getattribute___doc = "x.__getattribute__('name') <==> x.name"; @@ -832,7 +963,7 @@ "T.__new__(S, ...) -> a new object with type S, a subtype of T"; public final static String slice___reduce___doc = - "helper for pickle"; + "Return state information for pickling."; public final static String slice___reduce_ex___doc = "helper for pickle"; @@ -843,9 +974,21 @@ public final static String slice___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String slice___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String slice___str___doc = "x.__str__() <==> str(x)"; + public final static String slice___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String slice_indices_doc = "S.indices(len) -> (start, stop, stride)\n" + "\n" + @@ -878,8 +1021,11 @@ "Typical use to call a cooperative superclass method:\n" + "class C(B):\n" + " def meth(self, arg):\n" + - " super(C, self).meth(arg)"; + " super(C, self).meth(arg)"; + public final static String super___format___doc = + "default object formatter"; + public final static String super___get___doc = "descr.__get__(obj[, type]) -> value"; @@ -913,9 +1059,21 @@ public final static String super___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String super___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String super___str___doc = "x.__str__() <==> str(x)"; + public final static String super___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String super___thisclass___doc = "the class invoking super()"; @@ -945,6 +1103,9 @@ "Static methods in Python are similar to those found in Java or C++.\n" + "For a more advanced concept, see the classmethod builtin."; + public final static String staticmethod___format___doc = + "default object formatter"; + public final static String staticmethod___get___doc = "descr.__get__(obj[, type]) -> value"; @@ -972,9 +1133,21 @@ public final static String staticmethod___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String staticmethod___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String staticmethod___str___doc = "x.__str__() <==> str(x)"; + public final static String staticmethod___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + // Docs for <type 'float'> public final static String float___abs___doc = "x.__abs__() <==> abs(x)"; @@ -1012,6 +1185,11 @@ public final static String float___floordiv___doc = "x.__floordiv__(y) <==> x//y"; + public final static String float___format___doc = + "float.__format__(format_spec) -> string\n" + + "\n" + + "Formats the float according to format_spec."; + public final static String float___ge___doc = "x.__ge__(y) <==> x>=y"; @@ -1128,15 +1306,74 @@ "Overrides the automatic determination of C-level floating point type.\n" + "This affects how floats are converted to and from binary strings."; + public final static String float___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String float___str___doc = "x.__str__() <==> str(x)"; public final static String float___sub___doc = "x.__sub__(y) <==> x-y"; + public final static String float___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String float___truediv___doc = "x.__truediv__(y) <==> x/y"; + public final static String float___trunc___doc = + "Returns the Integral closest to x between 0 and x."; + + public final static String float_as_integer_ratio_doc = + "float.as_integer_ratio() -> (int, int)\n" + + "\n" + + "Returns a pair of integers, whose ratio is exactly equal to the original\n" + + "float and with a positive denominator.\n" + + "Raises OverflowError on infinities and a ValueError on NaNs.\n" + + "\n" + + ">>> (10.0).as_integer_ratio()\n" + + "(10, 1)\n" + + ">>> (0.0).as_integer_ratio()\n" + + "(0, 1)\n" + + ">>> (-.25).as_integer_ratio()\n" + + "(-1, 4)"; + + public final static String float_conjugate_doc = + "Returns self, the complex conjugate of any float."; + + public final static String float_fromhex_doc = + "float.fromhex(string) -> float\n" + + "\n" + + "Create a floating-point number from a hexadecimal string.\n" + + ">>> float.fromhex('0x1.ffffp10')\n" + + "2047.984375\n" + + ">>> float.fromhex('-0x1p-1074')\n" + + "-4.9406564584124654e-324"; + + public final static String float_hex_doc = + "float.hex() -> string\n" + + "\n" + + "Return a hexadecimal representation of a floating-point number.\n" + + ">>> (-0.1).hex()\n" + + "'-0x1.999999999999ap-4'\n" + + ">>> 3.14159.hex()\n" + + "'0x1.921f9f01b866ep+1'"; + + public final static String float_imag_doc = + "the imaginary part of a complex number"; + + public final static String float_is_integer_doc = + "Returns True if the float is an integer."; + + public final static String float_real_doc = + "the real part of a complex number"; + // Docs for <type 'enumerate'> public final static String enumerate___class___doc = "type(object) -> the object's type\n" + @@ -1148,11 +1385,14 @@ public final static String enumerate_doc = "enumerate(iterable) -> iterator for index, value of iterable\n" + "\n" + - "Return an enumerate object. iterable must be an other object that supports\n" + + "Return an enumerate object. iterable must be another object that supports\n" + "iteration. The enumerate object yields pairs containing a count (from\n" + "zero) and a value yielded by the iterable argument. enumerate is useful\n" + "for obtaining an indexed list: (0, seq[0]), (1, seq[1]), (2, seq[2]), ..."; + public final static String enumerate___format___doc = + "default object formatter"; + public final static String enumerate___getattribute___doc = "x.__getattribute__('name') <==> x.name"; @@ -1180,9 +1420,21 @@ public final static String enumerate___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String enumerate___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String enumerate___str___doc = "x.__str__() <==> str(x)"; + public final static String enumerate___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String enumerate_next_doc = "x.next() -> the next value, or raise StopIteration"; @@ -1197,6 +1449,9 @@ public final static String basestring_doc = "Type basestring cannot be instantiated; it is the base for str and unicode."; + public final static String basestring___format___doc = + "default object formatter"; + public final static String basestring___getattribute___doc = "x.__getattribute__('name') <==> x.name"; @@ -1221,9 +1476,21 @@ public final static String basestring___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String basestring___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String basestring___str___doc = "x.__str__() <==> str(x)"; + public final static String basestring___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + // Docs for <type 'long'> public final static String long___abs___doc = "x.__abs__() <==> abs(x)"; @@ -1268,6 +1535,9 @@ public final static String long___floordiv___doc = "x.__floordiv__(y) <==> x//y"; + public final static String long___format___doc = + ""; + public final static String long___getattribute___doc = "x.__getattribute__('name') <==> x.name"; @@ -1382,18 +1652,48 @@ public final static String long___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String long___sizeof___doc = + "Returns size in memory, in bytes"; + public final static String long___str___doc = "x.__str__() <==> str(x)"; public final static String long___sub___doc = "x.__sub__(y) <==> x-y"; + public final static String long___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String long___truediv___doc = "x.__truediv__(y) <==> x/y"; + public final static String long___trunc___doc = + "Truncating an Integral returns itself."; + public final static String long___xor___doc = "x.__xor__(y) <==> x^y"; + public final static String long_conjugate_doc = + "Returns self, the complex conjugate of any long."; + + public final static String long_denominator_doc = + "the denominator of a rational number in lowest terms"; + + public final static String long_imag_doc = + "the imaginary part of a complex number"; + + public final static String long_numerator_doc = + "the numerator of a rational number in lowest terms"; + + public final static String long_real_doc = + "the real part of a complex number"; + // Docs for <type 'tuple'> public final static String tuple___add___doc = "x.__add__(y) <==> x+y"; @@ -1417,6 +1717,9 @@ public final static String tuple___eq___doc = "x.__eq__(y) <==> x==y"; + public final static String tuple___format___doc = + "default object formatter"; + public final static String tuple___ge___doc = "x.__ge__(y) <==> x>=y"; @@ -1431,8 +1734,8 @@ public final static String tuple___getslice___doc = "x.__getslice__(i, j) <==> x[i:j]\n" + - " \n" + - " Use of negative indices is not supported."; + " \n" + + " Use of negative indices is not supported."; public final static String tuple___gt___doc = "x.__gt__(y) <==> x>y"; @@ -1479,9 +1782,28 @@ public final static String tuple___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String tuple___sizeof___doc = + "T.__sizeof__() -- size of T in memory, in bytes"; + public final static String tuple___str___doc = "x.__str__() <==> str(x)"; + public final static String tuple___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + + public final static String tuple_count_doc = + "T.count(value) -> integer -- return number of occurrences of value"; + + public final static String tuple_index_doc = + "T.index(value, [start, [stop]]) -> integer -- return first index of value.\n" + + "Raises ValueError if the value is not present."; + // Docs for <type 'str'> public final static String str___add___doc = "x.__add__(y) <==> x+y"; @@ -1505,6 +1827,11 @@ public final static String str___eq___doc = "x.__eq__(y) <==> x==y"; + public final static String str___format___doc = + "S.__format__(format_spec) -> unicode\n" + + "\n" + + ""; + public final static String str___ge___doc = "x.__ge__(y) <==> x>=y"; @@ -1519,8 +1846,8 @@ public final static String str___getslice___doc = "x.__getslice__(i, j) <==> x[i:j]\n" + - " \n" + - " Use of negative indices is not supported."; + " \n" + + " Use of negative indices is not supported."; public final static String str___gt___doc = "x.__gt__(y) <==> x>y"; @@ -1570,9 +1897,27 @@ public final static String str___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String str___sizeof___doc = + "S.__sizeof__() -> size of S in memory, in bytes"; + public final static String str___str___doc = "x.__str__() <==> str(x)"; + public final static String str___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + + public final static String str__formatter_field_name_split_doc = + ""; + + public final static String str__formatter_parser_doc = + ""; + public final static String str_capitalize_doc = "S.capitalize() -> string\n" + "\n" + @@ -1599,7 +1944,7 @@ "to the default encoding. errors may be given to set a different error\n" + "handling scheme. Default is 'strict' meaning that encoding errors raise\n" + "a UnicodeDecodeError. Other possible values are 'ignore' and 'replace'\n" + - "as well as any other name registerd with codecs.register_error that is\n" + + "as well as any other name registered with codecs.register_error that is\n" + "able to handle UnicodeDecodeErrors."; public final static String str_encode_doc = @@ -1630,11 +1975,16 @@ "S.find(sub [,start [,end]]) -> int\n" + "\n" + "Return the lowest index in S where substring sub is found,\n" + - "such that sub is contained within s[start,end]. Optional\n" + + "such that sub is contained within s[start:end]. Optional\n" + "arguments start and end are interpreted as in slice notation.\n" + "\n" + "Return -1 on failure."; + public final static String str_format_doc = + "S.format(*args, **kwargs) -> unicode\n" + + "\n" + + ""; + public final static String str_index_doc = "S.index(sub [,start [,end]]) -> int\n" + "\n" + @@ -1693,7 +2043,7 @@ public final static String str_ljust_doc = "S.ljust(width[, fillchar]) -> string\n" + "\n" + - "Return S left justified in a string of length width. Padding is\n" + + "Return S left-justified in a string of length width. Padding is\n" + "done using the specified fill character (default is a space)."; public final static String str_lower_doc = @@ -1711,9 +2061,9 @@ public final static String str_partition_doc = "S.partition(sep) -> (head, sep, tail)\n" + "\n" + - "Searches for the separator sep in S, and returns the part before it,\n" + + "Search for the separator sep in S, and return the part before it,\n" + "the separator itself, and the part after it. If the separator is not\n" + - "found, returns S and two empty strings."; + "found, return S and two empty strings."; public final static String str_replace_doc = "S.replace (old, new[, count]) -> string\n" + @@ -1726,7 +2076,7 @@ "S.rfind(sub [,start [,end]]) -> int\n" + "\n" + "Return the highest index in S where substring sub is found,\n" + - "such that sub is contained within s[start,end]. Optional\n" + + "such that sub is contained within s[start:end]. Optional\n" + "arguments start and end are interpreted as in slice notation.\n" + "\n" + "Return -1 on failure."; @@ -1739,15 +2089,15 @@ public final static String str_rjust_doc = "S.rjust(width[, fillchar]) -> string\n" + "\n" + - "Return S right justified in a string of length width. Padding is\n" + + "Return S right-justified in a string of length width. Padding is\n" + "done using the specified fill character (default is a space)"; public final static String str_rpartition_doc = "S.rpartition(sep) -> (tail, sep, head)\n" + "\n" + - "Searches for the separator sep in S, starting at the end of S, and returns\n" + + "Search for the separator sep in S, starting at the end of S, and return\n" + "the part before it, the separator itself, and the part after it. If the\n" + - "separator is not found, returns two empty strings and S."; + "separator is not found, return two empty strings and S."; public final static String str_rsplit_doc = "S.rsplit([sep [,maxsplit]]) -> list of strings\n" + @@ -1771,7 +2121,8 @@ "Return a list of the words in the string S, using sep as the\n" + "delimiter string. If maxsplit is given, at most maxsplit\n" + "splits are done. If sep is not specified or is None, any\n" + - "whitespace string is a separator."; + "whitespace string is a separator and empty strings are removed\n" + + "from the result."; public final static String str_splitlines_doc = "S.splitlines([keepends]) -> list of strings\n" + @@ -1845,11 +2196,24 @@ "fset is a function for setting, and fdel a function for del'ing, an\n" + "attribute. Typical use is to define a managed attribute x:\n" + "class C(object):\n" + - " def getx(self): return self.__x\n" + - " def setx(self, value): self.__x = value\n" + - " def delx(self): del self.__x\n" + - " x = property(getx, setx, delx, \"I'm the 'x' property.\")"; + " def getx(self): return self._x\n" + + " def setx(self, value): self._x = value\n" + + " def delx(self): del self._x\n" + + " x = property(getx, setx, delx, \"I'm the 'x' property.\")\n" + + "\n" + + "Decorators make defining new properties or modifying existing ones easy:\n" + + "class C(object):\n" + + " @property\n" + + " def x(self): return self._x\n" + + " @x.setter\n" + + " def x(self, value): self._x = value\n" + + " @x.deleter\n" + + " def x(self): del self._x\n" + + ""; + public final static String property___format___doc = + "default object formatter"; + public final static String property___get___doc = "descr.__get__(obj[, type]) -> value"; @@ -1880,9 +2244,24 @@ public final static String property___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String property___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String property___str___doc = "x.__str__() <==> str(x)"; + public final static String property___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + + public final static String property_deleter_doc = + "Descriptor to change the deleter on a property."; + public final static String property_fdel_doc = ""; @@ -1892,6 +2271,12 @@ public final static String property_fset_doc = ""; + public final static String property_getter_doc = + "Descriptor to change the getter on a property."; + + public final static String property_setter_doc = + "Descriptor to change the setter on a property."; + // Docs for <type 'int'> public final static String int___abs___doc = "x.__abs__() <==> abs(x)"; @@ -1928,8 +2313,9 @@ "argument will be truncated towards zero (this does not include a string\n" + "representation of a floating point number!) When converting a string, use\n" + "the optional base. It is an error to supply a base when converting a\n" + - "non-string. If the argument is outside the integer range a long object\n" + - "will be returned instead."; + "non-string. If base is zero, the proper base is guessed based on the\n" + + "string content. If the argument is outside the integer range a\n" + + "long object will be returned instead."; public final static String int___float___doc = "x.__float__() <==> float(x)"; @@ -1937,6 +2323,9 @@ public final static String int___floordiv___doc = "x.__floordiv__(y) <==> x//y"; + public final static String int___format___doc = + ""; + public final static String int___getattribute___doc = "x.__getattribute__('name') <==> x.name"; @@ -2051,18 +2440,48 @@ public final static String int___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String int___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String int___str___doc = "x.__str__() <==> str(x)"; public final static String int___sub___doc = "x.__sub__(y) <==> x-y"; + public final static String int___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String int___truediv___doc = "x.__truediv__(y) <==> x/y"; + public final static String int___trunc___doc = + "Truncating an Integral returns itself."; + public final static String int___xor___doc = "x.__xor__(y) <==> x^y"; + public final static String int_conjugate_doc = + "Returns self, the complex conjugate of any int."; + + public final static String int_denominator_doc = + "the denominator of a rational number in lowest terms"; + + public final static String int_imag_doc = + "the imaginary part of a complex number"; + + public final static String int_numerator_doc = + "the numerator of a rational number in lowest terms"; + + public final static String int_real_doc = + "the real part of a complex number"; + // Docs for <type 'xrange'> public final static String xrange___class___doc = "type(object) -> the object's type\n" + @@ -2078,6 +2497,9 @@ "generates the numbers in the range on demand. For looping, this is \n" + "slightly faster than range() and more memory efficient."; + public final static String xrange___format___doc = + "default object formatter"; + public final static String xrange___getattribute___doc = "x.__getattribute__('name') <==> x.name"; @@ -2100,7 +2522,7 @@ "T.__new__(S, ...) -> a new object with type S, a subtype of T"; public final static String xrange___reduce___doc = - "helper for pickle"; + ""; public final static String xrange___reduce_ex___doc = "helper for pickle"; @@ -2114,9 +2536,21 @@ public final static String xrange___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String xrange___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String xrange___str___doc = "x.__str__() <==> str(x)"; + public final static String xrange___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + // Docs for <type 'file'> public final static String file___class___doc = "type(object) -> the object's type\n" + @@ -2134,7 +2568,8 @@ "opened for writing. Add a 'b' to the mode for binary files.\n" + "Add a '+' to the mode to allow simultaneous reading and writing.\n" + "If the buffering argument is given, 0 means unbuffered, 1 means line\n" + - "buffered, and larger numbers specify the buffer size.\n" + + "buffered, and larger numbers specify the buffer size. The preferred way\n" + + "to open a file is with the builtin open() function.\n" + "Add a 'U' to mode to open the file for input with universal newline\n" + "support. Any line ending in the input file will be seen as a '\\n'\n" + "in Python. Also, a file so opened gains the attribute 'newlines';\n" + @@ -2150,6 +2585,9 @@ public final static String file___exit___doc = "__exit__(*excinfo) -> None. Closes the file."; + public final static String file___format___doc = + "default object formatter"; + public final static String file___getattribute___doc = "x.__getattribute__('name') <==> x.name"; @@ -2177,9 +2615,21 @@ public final static String file___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String file___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String file___str___doc = "x.__str__() <==> str(x)"; + public final static String file___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String file_close_doc = "close() -> None or (perhaps) an integer. Close the file.\n" + "\n" + @@ -2194,6 +2644,9 @@ public final static String file_encoding_doc = "file encoding"; + public final static String file_errors_doc = + "Unicode error handler"; + public final static String file_fileno_doc = "fileno() -> integer \"file descriptor\".\n" + "\n" + @@ -2320,6 +2773,9 @@ public final static String complex___floordiv___doc = "x.__floordiv__(y) <==> x//y"; + public final static String complex___format___doc = + "default object formatter"; + public final static String complex___ge___doc = "x.__ge__(y) <==> x>=y"; @@ -2413,17 +2869,31 @@ public final static String complex___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String complex___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String complex___str___doc = "x.__str__() <==> str(x)"; public final static String complex___sub___doc = "x.__sub__(y) <==> x-y"; + public final static String complex___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String complex___truediv___doc = "x.__truediv__(y) <==> x/y"; public final static String complex_conjugate_doc = - ""; + "complex.conjugate() -> complex\n" + + "\n" + + "Returns the complex conjugate of its argument. (3-4j).conjugate() == 3+4j."; public final static String complex_imag_doc = "the imaginary part of a complex number"; @@ -2473,6 +2943,9 @@ public final static String bool___floordiv___doc = "x.__floordiv__(y) <==> x//y"; + public final static String bool___format___doc = + ""; + public final static String bool___getattribute___doc = "x.__getattribute__('name') <==> x.name"; @@ -2587,18 +3060,48 @@ public final static String bool___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String bool___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String bool___str___doc = "x.__str__() <==> str(x)"; public final static String bool___sub___doc = "x.__sub__(y) <==> x-y"; + public final static String bool___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String bool___truediv___doc = "x.__truediv__(y) <==> x/y"; + public final static String bool___trunc___doc = + "Truncating an Integral returns itself."; + public final static String bool___xor___doc = "x.__xor__(y) <==> x^y"; + public final static String bool_conjugate_doc = + "Returns self, the complex conjugate of any int."; + + public final static String bool_denominator_doc = + "the denominator of a rational number in lowest terms"; + + public final static String bool_imag_doc = + "the imaginary part of a complex number"; + + public final static String bool_numerator_doc = + "the numerator of a rational number in lowest terms"; + + public final static String bool_real_doc = + "the real part of a complex number"; + // Docs for <type 'classmethod'> public final static String classmethod___class___doc = "type(object) -> the object's type\n" + @@ -2628,6 +3131,9 @@ "Class methods are different than C++ or Java static methods.\n" + "If you want those, see the staticmethod builtin."; + public final static String classmethod___format___doc = + "default object formatter"; + public final static String classmethod___get___doc = "descr.__get__(obj[, type]) -> value"; @@ -2655,9 +3161,21 @@ public final static String classmethod___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String classmethod___sizeof___doc = + "__sizeof__() -> size of object in memory, in bytes"; + public final static String classmethod___str___doc = "x.__str__() <==> str(x)"; + public final static String classmethod___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + // Docs for <type 'set'> public final static String set___and___doc = "x.__and__(y) <==> x&y"; @@ -2683,6 +3201,9 @@ public final static String set___eq___doc = "x.__eq__(y) <==> x==y"; + public final static String set___format___doc = + "default object formatter"; + public final static String set___ge___doc = "x.__ge__(y) <==> x>=y"; @@ -2693,7 +3214,7 @@ "x.__gt__(y) <==> x>y"; public final static String set___hash___doc = - "x.__hash__() <==> hash(x)"; + ""; public final static String set___iand___doc = "x.__iand__(y) <==> x&y"; @@ -2755,12 +3276,24 @@ public final static String set___setattr___doc = "x.__setattr__('name', value) <==> x.name = value"; + public final static String set___sizeof___doc = + "S.__sizeof__() -> size of S in memory, in bytes"; + public final static String set___str___doc = "x.__str__() <==> str(x)"; public final static String set___sub___doc = "x.__sub__(y) <==> x-y"; + public final static String set___subclasshook___doc = + "Abstract classes can override this to customize issubclass().\n" + + "\n" + + "This is invoked early on by abc.ABCMeta.__subclasscheck__().\n" + + "It should return True, False or NotImplemented. If it returns\n" + + "NotImplemented, the normal algorithm is used. Otherwise, it\n" + + "overrides the normal algorithm (and the outcome is cached).\n" + + ""; + public final static String set___xor___doc = "x.__xor__(y) <==> x^y"; @@ -2776,9 +3309,9 @@ "Return a shallow copy of a set."; public final static String set_difference_doc = - "Return the difference of two sets as a new set.\n" + + "Return the difference of two or more sets as a new set.\n" + "\n" + - "(i.e. all elements that are in this set but not the other.)"; + "(i.e. all elements that are in this set but not the others.)"; public final static String set_difference_update_doc = "Remove all elements of another set from this set."; @@ -2796,6 +3329,9 @@ public final static String set_intersection_update_doc = "Update a set with the intersection of itself and another."; + public final static String set_isdisjoint_doc = + "Return True if two sets have a null intersection."; + public final static String set_issubset_doc = "Report whether another set contains this set."; @@ -2803,7 +3339,8 @@ "Report whether this set contains another set."; public final static String set_pop_doc = - "Remove and return an arbitrary set element."; + "Remove and return an arbitrary set element.\n" + + "Raises KeyError if the set is empty."; public final static String set_remove_doc = "Remove an ... [truncated message content] |