1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
from typing import TYPE_CHECKING, Any, Dict
from .region import Region
if TYPE_CHECKING:
from .document import Document
class SybilFailure(AssertionError):
def __init__(self, example: 'Example', result: str) -> None:
super(SybilFailure, self).__init__((
'Example at {}, line {}, column {} did not evaluate as expected:\n'
'{}'
).format(example.path, example.line, example.column, result))
self.example = example
self.result = result
class NotEvaluated(Exception):
"""
An exception that can be raised by an :any:`Evaluator` previously
:meth:`pushed <sybil.Document.push_evaluator>` onto the document to indicate that
it is not evaluating the current example and that a previously pushed evaluator, or the
:any:`Region` evaluator if no others have been pushed, should be used to evaluate the
:any:`Example` instead.
"""
class Example:
"""
This represents a particular example from a documentation source file.
It is assembled from the :class:`~sybil.document.Document` and
:class:`~sybil.Region` the example comes from and is passed to the region's
evaluator.
"""
def __init__(
self, document: 'Document', line: int, column: int, region: Region, namespace: Dict[str, Any]
) -> None:
#: The :class:`~sybil.document.Document` from which this example came.
self.document: 'Document' = document
#: The absolute path of the :class:`~sybil.document.Document`.
self.path: str = document.path
#: The line number at which this example occurs in the
#: :class:`~sybil.document.Document`.
self.line: int = line
#: The column number at which this example occurs in the
#: :class:`~sybil.document.Document`.
self.column: int = column
#: The :class:`~sybil.Region` from which this example came.
self.region: Region = region
#: The character position at which this example starts in the
#: :class:`~sybil.document.Document`.
self.start: int = region.start
#: The character position at which this example ends in the
#: :class:`~sybil.document.Document`.
self.end: int = region.end
#: The version of this example provided by the parser that yielded
#: the :class:`~sybil.Region` containing it.
self.parsed: Any = region.parsed
#: The :attr:`~sybil.Document.namespace` of the document from
#: which this example came.
self.namespace: Dict[str, Any] = namespace
def __repr__(self) -> str:
return '<Example path={} line={} column={} using {!r}>'.format(
self.path, self.line, self.column, self.region.evaluator
)
def evaluate(self) -> None:
if self.region.evaluator is not None:
self.document.evaluate(self, self.region.evaluator)
|
