Module clingo.core

Core functionality used throught the clingo package.

'''
Core functionality used throught the clingo package.
'''

from typing import Callable, Tuple
from enum import Enum

from ._internal import _cb_error_panic, _ffi, _lib, _to_str

__all__ = [ 'Logger', 'MessageCode', 'TruthValue', 'version' ]

def version() -> Tuple[int, int, int]:
    '''
    Clingo's version as a tuple `(major, minor, revision)`.
    '''
    p_major = _ffi.new('int*')
    p_minor = _ffi.new('int*')
    p_revision = _ffi.new('int*')
    _lib.clingo_version(p_major, p_minor, p_revision)
    return p_major[0], p_minor[0], p_revision[0]

class MessageCode(Enum):
    '''
    Enumeration of messages codes.
    '''
    AtomUndefined = _lib.clingo_warning_atom_undefined
    '''
    Informs about an undefined atom in program.
    '''
    FileIncluded = _lib.clingo_warning_file_included
    '''
    Indicates that the same file was included multiple times.
    '''
    GlobalVariable = _lib.clingo_warning_global_variable
    '''
    Informs about a global variable in a tuple of an aggregate element.
    '''
    OperationUndefined = _lib.clingo_warning_operation_undefined
    '''
    Inform about an undefined arithmetic operation or unsupported weight of an
    aggregate.
    '''
    Other = _lib.clingo_warning_other
    '''
    Reports other kinds of messages.
    '''
    RuntimeError = _lib.clingo_warning_runtime_error
    '''
    To report multiple errors; a corresponding runtime error is raised later.
    '''
    VariableUnbounded = _lib.clingo_warning_variable_unbounded
    '''
    Informs about a CSP variable with an unbounded domain.
    '''

Logger = Callable[[MessageCode, str], None]

@_ffi.def_extern(onerror=_cb_error_panic, name='pyclingo_logger_callback')
def _pyclingo_logger_callback(code, message, data):
    '''
    Low-level logger callback.
    '''
    handler = _ffi.from_handle(data)
    handler(MessageCode(code), _to_str(message))

class TruthValue(Enum):
    '''
    Enumeration of the different truth values.
    '''
    False_ = _lib.clingo_external_type_false
    '''
    Represents truth value true.
    '''
    Free = _lib.clingo_external_type_free
    '''
    Represents absence of a truth value.
    '''
    True_ = _lib.clingo_external_type_true
    '''
    Represents truth value true.
    '''
    Release = _lib.clingo_external_type_release
    '''
    Indicates that an atom is to be released.
    '''

Functions

def version() ‑> Tuple[int, int, int]

Clingo's version as a tuple (major, minor, revision).

Expand source code

def version() -> Tuple[int, int, int]:
    '''
    Clingo's version as a tuple `(major, minor, revision)`.
    '''
    p_major = _ffi.new('int*')
    p_minor = _ffi.new('int*')
    p_revision = _ffi.new('int*')
    _lib.clingo_version(p_major, p_minor, p_revision)
    return p_major[0], p_minor[0], p_revision[0]

Classes

class MessageCode (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enumeration of messages codes.

Expand source code

class MessageCode(Enum):
    '''
    Enumeration of messages codes.
    '''
    AtomUndefined = _lib.clingo_warning_atom_undefined
    '''
    Informs about an undefined atom in program.
    '''
    FileIncluded = _lib.clingo_warning_file_included
    '''
    Indicates that the same file was included multiple times.
    '''
    GlobalVariable = _lib.clingo_warning_global_variable
    '''
    Informs about a global variable in a tuple of an aggregate element.
    '''
    OperationUndefined = _lib.clingo_warning_operation_undefined
    '''
    Inform about an undefined arithmetic operation or unsupported weight of an
    aggregate.
    '''
    Other = _lib.clingo_warning_other
    '''
    Reports other kinds of messages.
    '''
    RuntimeError = _lib.clingo_warning_runtime_error
    '''
    To report multiple errors; a corresponding runtime error is raised later.
    '''
    VariableUnbounded = _lib.clingo_warning_variable_unbounded
    '''
    Informs about a CSP variable with an unbounded domain.
    '''

Ancestors

• enum.Enum

Class variables

var AtomUndefined

Informs about an undefined atom in program.

var FileIncluded

Indicates that the same file was included multiple times.

var GlobalVariable

Informs about a global variable in a tuple of an aggregate element.

var OperationUndefined

Inform about an undefined arithmetic operation or unsupported weight of an aggregate.

var Other

Reports other kinds of messages.

var RuntimeError

To report multiple errors; a corresponding runtime error is raised later.

var VariableUnbounded

Informs about a CSP variable with an unbounded domain.

class TruthValue (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enumeration of the different truth values.

Expand source code

class TruthValue(Enum):
    '''
    Enumeration of the different truth values.
    '''
    False_ = _lib.clingo_external_type_false
    '''
    Represents truth value true.
    '''
    Free = _lib.clingo_external_type_free
    '''
    Represents absence of a truth value.
    '''
    True_ = _lib.clingo_external_type_true
    '''
    Represents truth value true.
    '''
    Release = _lib.clingo_external_type_release
    '''
    Indicates that an atom is to be released.
    '''

Ancestors

• enum.Enum

Class variables

var False_

Represents truth value true.

var Free

Represents absence of a truth value.

var Release

Indicates that an atom is to be released.

var True_

Represents truth value true.