lib/testtools/testtools/matchers/__init__.py

   1 # Copyright (c) 2008-2012 testtools developers. See LICENSE for details.
   2
   3 """All the matchers.
   4
   5 Matchers, a way to express complex assertions outside the testcase.
   6
   7 Inspired by 'hamcrest'.
   8
   9 Matcher provides the abstract API that all matchers need to implement.
  10
  11 Bundled matchers are listed in __all__: a list can be obtained by running
  12 $ python -c 'import testtools.matchers; print testtools.matchers.__all__'
  13 """
  14
  15 __all__ = [
  16     'AfterPreprocessing',
  17     'AllMatch',
  18     'Annotate',
  19     'Contains',
  20     'ContainsAll',
  21     'ContainedByDict',
  22     'ContainsDict',
  23     'DirContains',
  24     'DirExists',
  25     'DocTestMatches',
  26     'EndsWith',
  27     'Equals',
  28     'FileContains',
  29     'FileExists',
  30     'GreaterThan',
  31     'HasPermissions',
  32     'Is',
  33     'IsInstance',
  34     'KeysEqual',
  35     'LessThan',
  36     'MatchesAll',
  37     'MatchesAny',
  38     'MatchesDict',
  39     'MatchesException',
  40     'MatchesListwise',
  41     'MatchesPredicate',
  42     'MatchesRegex',
  43     'MatchesSetwise',
  44     'MatchesStructure',
  45     'NotEquals',
  46     'Not',
  47     'PathExists',
  48     'Raises',
  49     'raises',
  50     'SamePath',
  51     'StartsWith',
  52     'TarballContains',
  53     ]
  54
  55 from ._basic import (
  56     Contains,
  57     EndsWith,
  58     Equals,
  59     GreaterThan,
  60     Is,
  61     IsInstance,
  62     LessThan,
  63     MatchesRegex,
  64     NotEquals,
  65     StartsWith,
  66     )
  67 from ._datastructures import (
  68     ContainsAll,
  69     MatchesListwise,
  70     MatchesSetwise,
  71     MatchesStructure,
  72     )
  73 from ._dict import (
  74     ContainedByDict,
  75     ContainsDict,
  76     KeysEqual,
  77     MatchesDict,
  78     )
  79 from ._doctest import (
  80     DocTestMatches,
  81     )
  82 from ._exception import (
  83     MatchesException,
  84     Raises,
  85     raises,
  86     )
  87 from ._filesystem import (
  88     DirContains,
  89     DirExists,
  90     FileContains,
  91     FileExists,
  92     HasPermissions,
  93     PathExists,
  94     SamePath,
  95     TarballContains,
  96     )
  97 from ._higherorder import (
  98     AfterPreprocessing,
  99     AllMatch,
 100     Annotate,
 101     MatchesAll,
 102     MatchesAny,
 103     MatchesPredicate,
 104     Not,
 105     )
 106
 107 # XXX: These are not explicitly included in __all__.  It's unclear how much of
 108 # the public interface they really are.
 109 from ._impl import (
 110     Matcher,
 111     Mismatch,
 112     MismatchError,
 113     )