library Package¶

library Package¶

arithmetic Module¶

class contracts.library.arithmetic.Binary(exprs, glyph, where=None)[source]¶

Bases: contracts.interface.RValue

eval(context)[source]¶

operations = {'+': <function <lambda> at 0x1082668c0>, '*': <function <lambda> at 0x1082669b0>, '-': <function <lambda> at 0x108266938>}¶

static parse_action(s, loc, tokens)[source]¶

precedence = {'+': 0, '*': 1, '-': 0}¶

class contracts.library.arithmetic.Unary(glyph, expr, where=None)[source]¶

Bases: contracts.interface.RValue

eval(context)[source]¶

operations = {'-': <function <lambda> at 0x108266de8>}¶

static parse_action(s, loc, tokens)[source]¶

array Module¶

class contracts.library.array.Array(shape_contract=None, elements_contract=None, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

class contracts.library.array.Shape(length, contract, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

class contracts.library.array.ShapeContract(dimensions, ellipsis=False, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

contracts.library.array.my_delim_list2(what, delim)[source]¶

array_ops Module¶

class contracts.library.array_ops.ArrayAnd(clauses, where=None)[source]¶

Bases: contracts.library.array_ops.ArrayLogical

static parse_action(string, location, tokens)[source]¶

test_elements(context, value)[source]¶

class contracts.library.array_ops.ArrayConstraint(glyph, rvalue, where=None)[source]¶

Bases: contracts.library.array_ops.ArrayElementsTest

Comparisons for numpy array elements. They check that the condition is respected for all the entries in the array.

constraints = {'>=': <function <lambda> at 0x107b15ed8>, '==': <function <lambda> at 0x107b15d70>, '=': <function <lambda> at 0x107b15cf8>, '<=': <function <lambda> at 0x107b18050>, '!=': <function <lambda> at 0x107b15de8>, '<': <function <lambda> at 0x107b15f50>, '>': <function <lambda> at 0x107b15e60>}¶

static parse_action(s, loc, tokens)[source]¶

test_elements(context, value)[source]¶

Returns either a bool or an array of bool.

class contracts.library.array_ops.ArrayElementsTest(where)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

test_elements(context, value)[source]¶

Returns either a bool or an array of bool.

class contracts.library.array_ops.ArrayLogical(glyph, precedence)[source]¶

Bases: contracts.library.array_ops.ArrayElementsTest

class contracts.library.array_ops.ArrayOR(clauses, where=None)[source]¶

Bases: contracts.library.array_ops.ArrayLogical

static parse_action(string, location, tokens)[source]¶

test_elements(context, value)[source]¶

class contracts.library.array_ops.DType(dtype, dtype_string=None, where=None)[source]¶

Bases: contracts.library.array_ops.ArrayElementsTest

Checks that the value is an array with the given dtype.

static parse_action(dtype=None)[source]¶

test_elements(context, value)[source]¶

comparison Module¶

class contracts.library.comparison.CheckOrder(expr1, glyph, expr2, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

conditions = {'>=': (False, True, True), '==': (False, True, False), '=': (False, True, False), '<=': (True, True, False), '!=': (True, False, True), '<': (True, False, False), '>': (False, False, True)}¶

static parse_action(s, loc, tokens)[source]¶

compositions Module¶

class contracts.library.compositions.And(clauses, where=None)[source]¶

Bases: contracts.library.compositions.Logical, contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(string, location, tokens)[source]¶

class contracts.library.compositions.Logical(glyph, precedence)[source]¶

Bases: object

class contracts.library.compositions.OR(clauses, where=None)[source]¶

Bases: contracts.library.compositions.Logical, contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(string, location, tokens)[source]¶

dicts Module¶

class contracts.library.dicts.Dict(length=None, key_c=None, value_c=None, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

dummy Module¶

class contracts.library.dummy.Any(where=None)[source]¶

Bases: contracts.interface.Contract

Always true.

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

class contracts.library.dummy.Never(where=None)[source]¶

Bases: contracts.interface.Contract

A contract that does not match anything. Useful for debugging.

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

extensions Module¶

class contracts.library.extensions.CheckCallable(callable)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

class contracts.library.extensions.CheckCallableWithSelf(callable)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

class contracts.library.extensions.Extension(identifier, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

registrar = {'Hashable': CheckCallable(<function f at 0x107b62848>), 'Callable': CheckCallable(<function f at 0x107b66aa0>), 'None': CheckCallable(<function is_None at 0x107b6d1b8>), 'Set': CheckCallable(<function f at 0x107b66c80>), 'Container': CheckCallable(<function f at 0x107b668c0>), 'Iterator': CheckCallable(<function f at 0x107b62758>), 'Sequence': CheckCallable(<function f at 0x107b66b90>), 'MutableMapping': CheckCallable(<function f at 0x107b6d0c8>), 'Mapping': CheckCallable(<function f at 0x107b66f50>), 'MutableSequence': CheckCallable(<function f at 0x107b66d70>), 'Sized': CheckCallable(<function f at 0x107b669b0>), 'NoneType': CheckCallable(<function is_None at 0x107b6d1b8>), 'MutableSet': CheckCallable(<function f at 0x107b66e60>), 'Iterable': CheckCallable(<function f at 0x107b628c0>)}¶

lists Module¶

class contracts.library.lists.List(length_contract=None, elements_contract=None, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

map Module¶

class contracts.library.map.Map(length=None, key_c=None, value_c=None, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

miscellaneous_aliases Module¶

contracts.library.miscellaneous_aliases.is_None(x)[source]¶

contracts.library.miscellaneous_aliases.ist(C)[source]¶

separate_context Module¶

class contracts.library.separate_context.SeparateContext(contract, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

seq Module¶

class contracts.library.seq.Seq(length_contract=None, elements_contract=None, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

simple_values Module¶

class contracts.library.simple_values.EqualTo(rvalue, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

class contracts.library.simple_values.SimpleRValue(value, representation=None, where=None)[source]¶

Bases: contracts.interface.RValue

eval(context)[source]¶

strings Module¶

class contracts.library.strings.String(length=None, where=None)[source]¶

Bases: contracts.library.strings.StringBase

DESCRIPTION = 'an ANSI or Unicode string'¶

KEYWORDS = ['string']¶

TYPE¶

alias of basestring

class contracts.library.strings.AnsiString(length=None, where=None)[source]¶

Bases: contracts.library.strings.StringBase

DESCRIPTION = 'an ANSI string'¶

KEYWORDS = ['str']¶

TYPE¶

alias of str

class contracts.library.strings.UnicodeString(length=None, where=None)[source]¶

Bases: contracts.library.strings.StringBase

DESCRIPTION = 'a Unicode string'¶

KEYWORDS = ['unicode']¶

TYPE¶

alias of unicode

suggester Module¶

contracts.library.suggester.create_suggester(get_options, get_message=<function default_message at 0x10112e938>, pattern=Combine:({Re:('[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]') W:(_abc...)}))[source]¶

contracts.library.suggester.default_message(identifier)[source]¶

contracts.library.suggester.find_best_match(s, options)[source]¶

contracts.library.suggester.find_longest_match(s, options)[source]¶

contracts.library.suggester.levenshtein(a, b)[source]¶

Calculates the Levenshtein distance between a and b.

contracts.library.suggester.longest_match(a, b)[source]¶

tuple Module¶

class contracts.library.tuple.Tuple(length=None, elements=None, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

types_misc Module¶

class contracts.library.types_misc.CheckType(types, type_string=None, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(types)[source]¶

class contracts.library.types_misc.Type(type_constraint, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(s, loc, tokens)[source]¶

variables Module¶

class contracts.library.variables.BindVariable(variable, allowed_types, where=None)[source]¶

Bases: contracts.interface.Contract

check_contract(context, value)[source]¶

static parse_action(allowed_types)[source]¶

class contracts.library.variables.VariableRef(variable, where=None)[source]¶

Bases: contracts.interface.RValue

eval(context)[source]¶

static parse_action(s, loc, tokens)[source]¶