Surer 1.4.7 - Documentation

Contents:

• Introduction
• Getting Started
  • Installing
  • Activating
• Python version compatibility
• Disabling the monkey patching
• How sure works
  • Chainability
• Monkey-patching
  • Why CPython-only ?
• API Reference
  • Setup/Teardown
    • Example: Setup a Flask app for testing
    • Example: Multiple Setup and Teardown functions
  • Number Equality
    • (2 + 2).should.equal(4)
    • .equal(float, epsilon)
  • String Equality
    • .should_not.be.different_of(string)
    • .should.equal("a string")
  • String Similarity
    • .look_like()
  • Strings Matching Regular-Expressions
    • should.match()
  • Collections and Iterables
    • .equal({'a': 'collection'})
    • .contain()
    • .should.be.empty
    • {number}.should.be.within(0, 10)
    • .be.within({iterable})
    • .be.none
    • .be.ok
    • .have.property()
    • .have.key()
    • .have.length_of(2)
    • {X}.should.be.greater_than(Y) and {Y}.should.be.lower_than(X)
  • Callables
    • callable.when.called_with(arg1, kwarg1=2).should.have.raised(Exception)
    • .should.throw(Exception)
    • function.when.called_with(arg1, kwarg1=2).should.return_value(value)
    • .be.a('typename')
    • .be.a(type)
    • .be.above(num) and .be.below(num)
  • it(), this(), those(), these()
    • Too long, don’t read
    • (lambda: None).should.be.callable
  • Synonyms
    • Positive synonyms
    • Negative synonyms
    • Chain-up synonyms
    • Equality synonyms
    • Positive boolean synonyms
    • Negative boolean synonyms
  • API Builtin Documentation
  • Add custom assertions, chains and chain properties
    • Custom assertion methods
    • Chain methods
    • Chain properties
  • Use custom assertion messages with ensure
• About sure

Indices and tables

• Index

• Module Index

• Search Page