-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
108 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# pyright: basic | ||
# pyright: reportUndefinedVariable=false | ||
|
||
|
||
from typing import Any | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# pyright: basic | ||
|
||
|
||
from typing import Any | ||
|
||
from parsita import Parser, ParserContext, lit, opt, reg, rep, success | ||
|
||
from dokyu.parser.docstring.utils import double_indent, identifiers, indent | ||
from dokyu.schema.docstring import Example | ||
|
||
|
||
def to_example_code(example_code_lines: list[Any]) -> Parser[str, str]: | ||
return success("\n".join(example_code_lines)) | ||
|
||
|
||
def to_examples(examples_raw: list[Any]) -> Parser[str, list[Example]]: | ||
examples = [] | ||
for example_info in examples_raw: | ||
lang_, label_, code = example_info | ||
lang = lang_.strip() | ||
label = label_.strip() if label_ else None | ||
examples.append(Example(description=None, lang=lang, label=label, code=code)) | ||
return success(examples) | ||
|
||
|
||
class ExamplesParser(ParserContext, whitespace=None): | ||
next_line = lit("\n") & indent | ||
blank_line = lit("\n") | ||
examples_head = lit("Examples:") | ||
example_code_block_head = indent >> reg(r".. code-block::\s*") >> identifiers << lit("\n") | ||
# example_code_block_description = rep(double_indent >> reg(r".*") << lit("\n")) | ||
example_code_block_label = opt(double_indent >> reg(r":name:\s*") >> reg(r".+") << lit("\n")) | ||
example_code_block_body = ( | ||
rep((double_indent >> reg(r".+") << lit("\n")) | (lit("") << blank_line)) >= to_example_code | ||
) | ||
example_code_block = example_code_block_head & example_code_block_label << blank_line & example_code_block_body | ||
examples_body = lit("\n") >> rep(example_code_block << rep(blank_line)) | ||
examples = examples_head >> examples_body >= to_examples |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# pyright: basic | ||
|
||
import pytest | ||
from parsita import Success | ||
|
||
from dokyu.parser.docstring.examples import ExamplesParser | ||
from dokyu.schema.docstring import Example | ||
|
||
|
||
@pytest.mark.parametrize( | ||
("examples_string", "expected"), | ||
[ | ||
( | ||
"""\ | ||
Examples: | ||
.. code-block:: python | ||
>>> import paddle | ||
>>> a = paddle.to_tensor(1) | ||
>>> b = paddle.to_tensor(2) | ||
>>> paddle.add(a, b) | ||
Tensor(shape=[], dtype=int64, place=CPUPlace, stop_gradient=True) | ||
""", | ||
[ | ||
Example( | ||
description=None, | ||
lang="python", | ||
label=None, | ||
code="""\ | ||
>>> import paddle | ||
>>> a = paddle.to_tensor(1) | ||
>>> b = paddle.to_tensor(2) | ||
>>> paddle.add(a, b) | ||
Tensor(shape=[], dtype=int64, place=CPUPlace, stop_gradient=True)""", | ||
) | ||
], | ||
), | ||
], | ||
) | ||
def test_parse_returns(examples_string: str, expected: list[Example]): | ||
res = ExamplesParser.examples.parse(examples_string) | ||
assert isinstance(res, Success) | ||
assert res.unwrap() == expected |