4Suite API Documentation: Ft.Xml.XPath.XPathTypes

4Suite™ API Documentation

# ► Module Ft.Xml.XPath.XPathTypes

Mappings between Python types and standard XPath object types

    Copyright 2004 Fourthought, Inc. (USA).
    Detailed license and copyright information: http://4suite.org/COPYRIGHT
    Project home, documentation, distributions: http://4suite.org/

Classes: BooleanType, NodesetType, NumberType, StringType |  |  |  | Globals: g_xpathPrimitiveTypes, g_xpathRecognizedNodes

## Classes

class BooleanType(object)

  ### Methods

  __and__(...)
    x.__and__(y) <==> x&y
  __cmp__(...)
    x.__cmp__(y) <==> cmp(x,y)
  __coerce__(...)
    x.__coerce__(y) <==> coerce(x, y)
  __float__(...)
    x.__float__() <==> float(x)
  __hash__(...)
    x.__hash__() <==> hash(x)
  __hex__(...)
    x.__hex__() <==> hex(x)
  __int__(...)
    x.__int__() <==> int(x)
  __long__(...)
    x.__long__() <==> long(x)
  __nonzero__(...)
    x.__nonzero__() <==> x != 0
  __oct__(...)
    x.__oct__() <==> oct(x)
  __or__(...)
    x.__or__(y) <==> x|y
  __rand__(...)
    x.__rand__(y) <==> y&x
  __repr__(...)
    x.__repr__() <==> repr(x)
  __ror__(...)
    x.__ror__(y) <==> y|x
  __rxor__(...)
    x.__rxor__(y) <==> y^x
  __str__(...)
    x.__str__() <==> str(x)
  __xor__(...)
    x.__xor__(y) <==> x^y

  ### Methods inherited from class object

  __delattr__, __getattribute__, __init__, __new__, __reduce__, __reduce_ex__, __setattr__

  ### Members inherited from class object

  __class__
class NodesetType(object)
  list() -> new list list(sequence) -> new list initialized from sequence's items

  ### Methods

  __add__(...)
    x.__add__(y) <==> x+y
  __contains__(...)
    x.__contains__(y) <==> y in x
  __delitem__(...)
    x.__delitem__(y) <==> del x[y]
  __delslice__(...)
    x.__delslice__(i, j) <==> del x[i:j]

        Use of negative indices is not supported.

  __eq__(...)
    x.__eq__(y) <==> x==y
  __ge__(...)
    x.__ge__(y) <==> x>=y
  __getattribute__(...)
    x.__getattribute__('name') <==> x.name
  __getitem__(...)
    x.__getitem__(y) <==> x[y]
  __getslice__(...)
    x.__getslice__(i, j) <==> x[i:j]

        Use of negative indices is not supported.

  __gt__(...)
    x.__gt__(y) <==> x>y
  __hash__(...)
    x.__hash__() <==> hash(x)
  __iadd__(...)
    x.__iadd__(y) <==> x+=y
  __imul__(...)
    x.__imul__(y) <==> x*=y
  __init__(...)
    x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  __iter__(...)
    x.__iter__() <==> iter(x)
  __le__(...)
    x.__le__(y) <==> x<=y
  __len__(...)
    x.__len__() <==> len(x)
  __lt__(...)
    x.__lt__(y) <==> x<y
  __mul__(...)
    x.__mul__(n) <==> x*n
  __ne__(...)
    x.__ne__(y) <==> x!=y
  __new__(...)
    T.__new__(S, ...) -> a new object with type S, a subtype of T
    Overrides: __new__ from class object
  __repr__(...)
    x.__repr__() <==> repr(x)
  __reversed__(...)
    L.__reversed__() -- return a reverse iterator over the list
  __rmul__(...)
    x.__rmul__(n) <==> n*x
  __setitem__(...)
    x.__setitem__(i, y) <==> x[i]=y
  __setslice__(...)
    x.__setslice__(i, j, y) <==> x[i:j]=y

        Use  of negative indices is not supported.

  append(...)
    L.append(object) -- append object to end
  count(...)
    L.count(value) -> integer -- return number of occurrences of value
  extend(...)
    L.extend(iterable) -- extend list by appending elements from the iterable
  index(...)
    L.index(value, [start, [stop]]) -> integer -- return first index of value
  insert(...)
    L.insert(index, object) -- insert object before index
  pop(...)
    L.pop([index]) -> item -- remove and return item at index (default last)
  remove(...)
    L.remove(value) -- remove first occurrence of value
  reverse(...)
    L.reverse() -- reverse *IN PLACE*
  sort(...)
    L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*; cmp(x, y) -> -1, 0, 1

  ### Methods inherited from class object

  __delattr__, __reduce__, __reduce_ex__, __setattr__, __str__

  ### Members inherited from class object

  __class__
class NumberType(object)
  float(x) -> floating point number

      Convert a string or number to a floating point number, if possible.

  ### Methods

  __abs__(...)
    x.__abs__() <==> abs(x)
  __add__(...)
    x.__add__(y) <==> x+y
  __coerce__(...)
    x.__coerce__(y) <==> coerce(x, y)
  __div__(...)
    x.__div__(y) <==> x/y
  __divmod__(...)
    x.__divmod__(y) <==> divmod(x, y)
  __eq__(...)
    x.__eq__(y) <==> x==y
  __float__(...)
    x.__float__() <==> float(x)
  __floordiv__(...)
    x.__floordiv__(y) <==> x//y
  __ge__(...)
    x.__ge__(y) <==> x>=y
  __getattribute__(...)
    x.__getattribute__('name') <==> x.name
  __getnewargs__(...)
  __gt__(...)
    x.__gt__(y) <==> x>y
  __hash__(...)
    x.__hash__() <==> hash(x)
  __int__(...)
    x.__int__() <==> int(x)
  __le__(...)
    x.__le__(y) <==> x<=y
  __long__(...)
    x.__long__() <==> long(x)
  __lt__(...)
    x.__lt__(y) <==> x<y
  __mod__(...)
    x.__mod__(y) <==> x%y
  __mul__(...)
    x.__mul__(y) <==> x*y
  __ne__(...)
    x.__ne__(y) <==> x!=y
  __neg__(...)
    x.__neg__() <==> -x
  __new__(...)
    T.__new__(S, ...) -> a new object with type S, a subtype of T
    Overrides: __new__ from class object
  __nonzero__(...)
    x.__nonzero__() <==> x != 0
  __pos__(...)
    x.__pos__() <==> +x
  __pow__(...)
    x.__pow__(y[, z]) <==> pow(x, y[, z])
  __radd__(...)
    x.__radd__(y) <==> y+x
  __rdiv__(...)
    x.__rdiv__(y) <==> y/x
  __rdivmod__(...)
    x.__rdivmod__(y) <==> divmod(y, x)
  __repr__(...)
    x.__repr__() <==> repr(x)
  __rfloordiv__(...)
    x.__rfloordiv__(y) <==> y//x
  __rmod__(...)
    x.__rmod__(y) <==> y%x
  __rmul__(...)
    x.__rmul__(y) <==> y*x
  __rpow__(...)
    y.__rpow__(x[, z]) <==> pow(x, y[, z])
  __rsub__(...)
    x.__rsub__(y) <==> y-x
  __rtruediv__(...)
    x.__rtruediv__(y) <==> y/x
  __str__(...)
    x.__str__() <==> str(x)
  __sub__(...)
    x.__sub__(y) <==> x-y
  __truediv__(...)
    x.__truediv__(y) <==> x/y

  ### Methods inherited from class object

  __delattr__, __init__, __reduce__, __reduce_ex__, __setattr__

  ### Members inherited from class object

  __class__
class StringType(basestring)
  unicode(string [, encoding[, errors]]) -> object

      Create a new Unicode object from the given encoded string.
      encoding defaults to the current default string encoding.
      errors can be 'strict', 'replace' or 'ignore' and defaults to 'strict'.

  ### Methods

  __add__(...)
    x.__add__(y) <==> x+y
  __cmp__(...)
    x.__cmp__(y) <==> cmp(x,y)
  __contains__(...)
    x.__contains__(y) <==> y in x
  __getattribute__(...)
    x.__getattribute__('name') <==> x.name
  __getitem__(...)
    x.__getitem__(y) <==> x[y]
  __getnewargs__(...)
  __getslice__(...)
    x.__getslice__(i, j) <==> x[i:j]

        Use of negative indices is not supported.

  __hash__(...)
    x.__hash__() <==> hash(x)
  __len__(...)
    x.__len__() <==> len(x)
  __mod__(...)
    x.__mod__(y) <==> x%y
  __mul__(...)
    x.__mul__(n) <==> x*n
  __new__(...)
    T.__new__(S, ...) -> a new object with type S, a subtype of T
    Overrides: __new__ from class basestring
  __repr__(...)
    x.__repr__() <==> repr(x)
  __rmod__(...)
    x.__rmod__(y) <==> y%x
  __rmul__(...)
    x.__rmul__(n) <==> n*x
  __str__(...)
    x.__str__() <==> str(x)
  capitalize(...)
    S.capitalize() -> unicode

        Return a capitalized version of S, i.e. make the first character
        have upper case.

  center(...)
    S.center(width[, fillchar]) -> unicode

        Return S centered in a Unicode string of length width. Padding is
        done using the specified fill character (default is a space)

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

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

  decode(...)
    S.decode([encoding[,errors]]) -> string or unicode

        Decodes S using the codec registered for encoding. encoding defaults
        to the default encoding. errors may be given to set a different error
        handling scheme. Default is 'strict' meaning that encoding errors raise
        a UnicodeDecodeError. Other possible values are 'ignore' and 'replace'
        as well as any other name registerd with codecs.register_error that is
        able to handle UnicodeDecodeErrors.

  encode(...)
    S.encode([encoding[,errors]]) -> string or unicode

        Encodes S using the codec registered for encoding. encoding defaults
        to the default encoding. errors may be given to set a different error
        handling scheme. 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.

  endswith(...)
    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.

  expandtabs(...)
    S.expandtabs([tabsize]) -> unicode

        Return a copy of S where all tab characters are expanded using spaces.
        If tabsize is not given, a tab size of 8 characters is assumed.

  find(...)
    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.

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

        Like S.find() but raise ValueError when the substring is not found.

  isalnum(...)
    S.isalnum() -> bool

        Return True if all characters in S are alphanumeric
        and there is at least one character in S, False otherwise.

  isalpha(...)
    S.isalpha() -> bool

        Return True if all characters in S are alphabetic
        and there is at least one character in S, False otherwise.

  isdecimal(...)
    S.isdecimal() -> bool

        Return True if there are only decimal characters in S,
        False otherwise.

  isdigit(...)
    S.isdigit() -> bool

        Return True if all characters in S are digits
        and there is at least one character in S, False otherwise.

  islower(...)
    S.islower() -> bool

        Return True if all cased characters in S are lowercase and there is
        at least one cased character in S, False otherwise.

  isnumeric(...)
    S.isnumeric() -> bool

        Return True if there are only numeric characters in S,
        False otherwise.

  isspace(...)
    S.isspace() -> bool

        Return True if all characters in S are whitespace
        and there is at least one character in S, False otherwise.

  istitle(...)
    S.istitle() -> bool

        Return True if S is a titlecased string and there is at least one
        character in S, i.e. upper- and titlecase characters may only
        follow uncased characters and lowercase characters only cased ones.
        Return False otherwise.

  isupper(...)
    S.isupper() -> bool

        Return True if all cased characters in S are uppercase and there is
        at least one cased character in S, False otherwise.

  join(...)
    S.join(sequence) -> unicode

        Return a string which is the concatenation of the strings in the
        sequence.  The separator between elements is S.

  ljust(...)
    S.ljust(width[, fillchar]) -> int

        Return S left justified in a Unicode string of length width. Padding is
        done using the specified fill character (default is a space).

  lower(...)
    S.lower() -> unicode

        Return a copy of the string S converted to lowercase.

  lstrip(...)
    S.lstrip([chars]) -> unicode

        Return a copy of the string S with leading whitespace removed.
        If chars is given and not None, remove characters in chars instead.
        If chars is a str, it will be converted to unicode before stripping

  replace(...)
    S.replace (old, new[, maxsplit]) -> unicode

        Return a copy of S with all occurrences of substring
        old replaced by new.  If the optional argument maxsplit is
        given, only the first maxsplit occurrences are replaced.

  rfind(...)
    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.

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

        Like S.rfind() but raise ValueError when the substring is not found.

  rjust(...)
    S.rjust(width[, fillchar]) -> unicode

        Return S right justified in a Unicode string of length width. Padding is
        done using the specified fill character (default is a space).

  rsplit(...)
    S.rsplit([sep [,maxsplit]]) -> list of strings

        Return a list of the words in S, using sep as the
        delimiter string, starting at the end of the string and
        working to the front.  If maxsplit is given, at most maxsplit
        splits are done. If sep is not specified, any whitespace string
        is a separator.

  rstrip(...)
    S.rstrip([chars]) -> unicode

        Return a copy of the string S with trailing whitespace removed.
        If chars is given and not None, remove characters in chars instead.
        If chars is a str, it will be converted to unicode before stripping

  split(...)
    S.split([sep [,maxsplit]]) -> list of strings

        Return a list of the words in S, using sep as the
        delimiter string.  If maxsplit is given, at most maxsplit
        splits are done. If sep is not specified or is None,
        any whitespace string is a separator.

  splitlines(...)
    S.splitlines([keepends]]) -> list of strings

        Return a list of the lines in S, breaking at line boundaries.
        Line breaks are not included in the resulting list unless keepends
        is given and true.

  startswith(...)
    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.

  strip(...)
    S.strip([chars]) -> unicode

        Return a copy of the string S with leading and trailing
        whitespace removed.
        If chars is given and not None, remove characters in chars instead.
        If chars is a str, it will be converted to unicode before stripping

  swapcase(...)
    S.swapcase() -> unicode

        Return a copy of S with uppercase characters converted to lowercase
        and vice versa.

  title(...)
    S.title() -> unicode

        Return a titlecased version of S, i.e. words start with title case
        characters, all remaining cased characters have lower case.

  translate(...)
    S.translate(table) -> unicode

        Return a copy of the string S, where all characters have been mapped
        through the given translation table, which must be a mapping of
        Unicode ordinals to Unicode ordinals, Unicode strings or None.
        Unmapped characters are left untouched. Characters mapped to None
        are deleted.

  upper(...)
    S.upper() -> unicode

        Return a copy of S converted to uppercase.

  zfill(...)
    S.zfill(width) -> unicode

        Pad a numeric string x with zeros on the left, to fill a field
        of the specified width. The string x is never truncated.

  ### Methods inherited from class object

  __delattr__, __init__, __reduce__, __reduce_ex__, __setattr__

  ### Members inherited from class object

  __class__

## Globals

g_xpathPrimitiveTypes = {<type 'float'>: 'number', <type 'int'>: 'number', <type 'list'>: 'node-set', <type 'long'>: 'number', <type 'str'>: 'string', <type 'object'>: 'object', <type 'unicode'>: 'string', <type 'bool'>: 'boolean', <type 'boolean'>: 'boolean'}
g_xpathRecognizedNodes = {1: True, 2: True, 3: True, 7: True, 8: True, 9: True, 13: True}