Docs for FORM.__doc__

[ Python Tutorial ] [ Python Libraries ] [ web2py source docs ]

Description


<class 'str'>


str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.



Attributes


FORM.__doc__.__add__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return self+value.


FORM.__doc__.__class__ <class 'type'> extends (<class 'object'>,) belongs to class <class 'type'>

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.


FORM.__doc__.__contains__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return key in self.


FORM.__doc__.__delattr__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Implement delattr(self, name).


FORM.__doc__.__dir__ <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Default dir() implementation.


FORM.__doc__.__doc__ <class 'str'> belongs to class <class 'str'>

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.


FORM.__doc__.__eq__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return self==value.


FORM.__doc__.__format__ <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a formatted version of the string as described by format_spec.


FORM.__doc__.__ge__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return self>=value.


FORM.__doc__.__getattribute__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return getattr(self, name).


FORM.__doc__.__getitem__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return self[key].


FORM.__doc__.__getnewargs__ <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

FORM.__doc__.__gt__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return self>value.


FORM.__doc__.__hash__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return hash(self).


FORM.__doc__.__init__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Initialize self. See help(type(self)) for accurate signature.


FORM.__doc__.__init_subclass__ <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.


FORM.__doc__.__iter__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Implement iter(self).


FORM.__doc__.__le__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return self<=value.


FORM.__doc__.__len__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return len(self).


FORM.__doc__.__lt__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return self<value.


FORM.__doc__.__mod__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return self%value.


FORM.__doc__.__mul__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return self*value.


FORM.__doc__.__ne__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return self!=value.


FORM.__doc__.__new__ <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Create and return a new object. See help(type) for accurate signature.


FORM.__doc__.__reduce__ <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Helper for pickle.


FORM.__doc__.__reduce_ex__ <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Helper for pickle.


FORM.__doc__.__repr__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return repr(self).


FORM.__doc__.__rmod__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return value%self.


FORM.__doc__.__rmul__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return value*self.


FORM.__doc__.__setattr__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Implement setattr(self, name, value).


FORM.__doc__.__sizeof__ <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return the size of the string in memory, in bytes.


FORM.__doc__.__str__ <class 'method-wrapper'> belongs to class <class 'method-wrapper'>

Return str(self).


FORM.__doc__.__subclasshook__ <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).


FORM.__doc__.capitalize <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.


FORM.__doc__.casefold <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a version of the string suitable for caseless comparisons.


FORM.__doc__.center <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).


FORM.__doc__.count <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.


FORM.__doc__.encode <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Encode the string using the codec registered for encoding.

encoding The encoding in which to encode the string. errors The error handling scheme to use for encoding errors. The default is 'strict' meaning that encoding errors raise a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and 'xmlcharrefreplace' as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.


FORM.__doc__.endswith <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.


FORM.__doc__.expandtabs <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.


FORM.__doc__.find <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

S.find(sub[, start[, end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.


FORM.__doc__.format <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

S.format(*args, **kwargs) -> str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').


FORM.__doc__.format_map <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

S.format_map(mapping) -> str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces ('{' and '}').


FORM.__doc__.index <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

S.index(sub[, start[, end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.


FORM.__doc__.isalnum <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.


FORM.__doc__.isalpha <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.


FORM.__doc__.isascii <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.


FORM.__doc__.isdecimal <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.


FORM.__doc__.isdigit <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.


FORM.__doc__.isidentifier <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is a valid Python identifier, False otherwise.

Use keyword.iskeyword() to test for reserved identifiers such as "def" and "class".


FORM.__doc__.islower <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.


FORM.__doc__.isnumeric <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.


FORM.__doc__.isprintable <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.


FORM.__doc__.isspace <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.


FORM.__doc__.istitle <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.


FORM.__doc__.isupper <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.


FORM.__doc__.join <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'


FORM.__doc__.ljust <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).


FORM.__doc__.lower <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a copy of the string converted to lowercase.


FORM.__doc__.lstrip <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.


FORM.__doc__.maketrans <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.


FORM.__doc__.partition <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.


FORM.__doc__.replace <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a copy with all occurrences of substring old replaced by new.

count Maximum number of occurrences to replace.

  • 1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.


FORM.__doc__.rfind <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

S.rfind(sub[, start[, end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.


FORM.__doc__.rindex <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

S.rindex(sub[, start[, end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.


FORM.__doc__.rjust <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).


FORM.__doc__.rpartition <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.


FORM.__doc__.rsplit <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a list of the words in the string, using sep as the delimiter string.

sep The delimiter according which to split the string. None (the default value) means split according to any whitespace, and discard empty strings from the result. maxsplit Maximum number of splits to do.

  • 1 (the default value) means no limit.

Splits are done starting at the end of the string and working to the front.


FORM.__doc__.rstrip <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.


FORM.__doc__.split <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a list of the words in the string, using sep as the delimiter string.

sep The delimiter according which to split the string. None (the default value) means split according to any whitespace, and discard empty strings from the result. maxsplit Maximum number of splits to do.

  • 1 (the default value) means no limit.

FORM.__doc__.splitlines <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.


FORM.__doc__.startswith <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.


FORM.__doc__.strip <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a copy of the string with leading and trailing whitespace remove.

If chars is given and not None, remove characters in chars instead.


FORM.__doc__.swapcase <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Convert uppercase characters to lowercase and lowercase characters to uppercase.


FORM.__doc__.title <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.


FORM.__doc__.translate <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Replace each character in the string using the given translation table.

table Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.


FORM.__doc__.upper <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Return a copy of the string converted to uppercase.


FORM.__doc__.zfill <class 'builtin_function_or_method'> belongs to class <class 'builtin_function_or_method'>

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.