.. module:: pychoir

API Reference
=============

Callables
---------
.. autoclass:: WhenPassedTo

Comparisons
-----------
.. autoclass:: EqualTo
.. autoclass:: GreaterThan
.. autoclass:: GreaterThanOrEqualTo
.. autoclass:: LessThan
.. autoclass:: LessThanOrEqualTo
.. autoclass:: NotEqualTo
.. autoclass:: EQ
.. autoclass:: GT
.. autoclass:: GTE
.. autoclass:: LT
.. autoclass:: LTE
.. autoclass:: NE

Containers
----------
.. autoclass:: All
.. autoclass:: AreNot
.. autoclass:: Contains
.. autoclass:: ContainsAllOf
.. autoclass:: ContainsAnyOf
.. autoclass:: ContainsNoneOf
.. autoclass:: DictContainsAllOf
.. autoclass:: HasLength
.. autoclass:: Len
.. autoclass:: InAnyOrder
.. autoclass:: IsEmpty
.. autoclass:: IsNotPresentOr
.. autoclass:: SetEquals
.. autoattribute:: containers.NotPresent
.. autoclass:: First
   :special-members: __call__
.. autoclass:: Last
   :special-members: __call__
.. autoattribute:: containers.Slice
.. autoclass:: pychoir.containers::_SliceFactory

Core
----
.. autoclass:: Matchable
   :members: __eq__
.. autoclass:: Matcher
   :members:
   :private-members:
   :special-members: __and__, __or__, __repr__
.. autofunction:: that
.. autoclass:: pychoir.core.MatcherWrapper
   :members:

Existential
-----------
.. autoclass:: Anything
.. autoclass:: In
.. autoclass:: Is
.. autoclass:: IsFalsy
.. autoclass:: IsNoneOr
.. autoclass:: IsTruthy
.. autoclass:: OneOf
.. autoclass:: Optionally

Integration
-----------
.. autoclass:: Matches
.. autoclass:: M
.. autoclass:: MatcherLike
   :members:
   :undoc-members:

Logical
-------
.. autoclass:: AllOf
.. autoclass:: And
.. autoclass:: AnyOf
.. autoclass:: IsNoneOf
.. autoclass:: Not
.. autoclass:: Or
.. autoclass:: ResultsTrueFor


Numeric
-------
.. autoclass:: IsEven
.. autoclass:: IsOdd
.. autoclass:: IsPositive
.. autoclass:: IsNonNegative
.. autoclass:: IsNegative


Strings
-------
.. autoclass:: EndsWith
.. autoclass:: MatchesRegex
.. autoclass:: StartsWith

Types
-----
.. autoclass:: ConvertsTo
.. autoclass:: IsInstance
.. autoclass:: OfType