File: codeblock.py

package info (click to toggle)
python-sybil 9.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,148 kB
  • sloc: python: 4,510; makefile: 90
file content (45 lines) | stat: -rw-r--r-- 1,562 bytes parent folder | download | duplicates (2)
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
from collections.abc import Sequence
from typing import Optional

from sybil.evaluators.python import pad, PythonEvaluator
from sybil.parsers.abstract import AbstractCodeBlockParser
from sybil.parsers.rest.lexers import DirectiveLexer, DirectiveInCommentLexer
from sybil.typing import Evaluator


class CodeBlockParser(AbstractCodeBlockParser):
    """
    A :any:`Parser` for :ref:`codeblock-parser` examples.

    :param language:
        The language that this parser should look for.

    :param evaluator:
        The evaluator to use for evaluating code blocks in the specified language.
        You can also override the :meth:`evaluate` method below.
    """

    def __init__(self, language: Optional[str] = None, evaluator: Optional[Evaluator] = None) -> None:
        super().__init__(
            [
                DirectiveLexer(directive=r'(sourcecode|code-block|code)'),
                DirectiveInCommentLexer(directive=r'(invisible-)?code(-block)?'),
            ],
            language, evaluator
        )

    pad = staticmethod(pad)


class PythonCodeBlockParser(CodeBlockParser):
    """
    A :any:`Parser` for Python :ref:`codeblock-parser` examples.

    :param future_imports:
        An optional sequence of strings that will be turned into
        ``from __future__ import ...`` statements and prepended to the code
        in each of the examples found by this parser.
    """

    def __init__(self, future_imports: Sequence[str] = ()) -> None:
        super().__init__(language='python', evaluator=PythonEvaluator(future_imports))