tree-sitter-python-docstring 0.0.1

PythonDocstring grammar for tree-sitter
Documentation 
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

module.exports = grammar({
  name: 'python_docstring',

  rules: {
    docstring: $ => seq(
      '"""',
      $.top_summary,
      optional($.summary),
      optional($.args_section),
      optional($.return_section),
      optional($.raises_section),
      optional($.examples_section),
      optional($.notes_section),
      optional($.attributes_section),
      '"""\n'
    ),
    top_summary: $ => /[^\n]+\./,
    summary: $ => seq($.summary_line, repeat($.summary_line)),
    summary_line: $ => /[^\n]+/,

    args_section: $ => seq(
      'Args:\n',
      repeat($.arg)
    ),
    arg: $ => seq(
      $.arg_name,
      optional($.type_annotation),
      ':',
      $.element_description
    ),
    arg_name: $ => /\s{4}(\*{0,2}[a-zA-Z_][a-zA-Z_0-9]*)/,

    type_annotation: $ => seq(
      ' (',
      $.type_name,
      ')'
    ),
    type_name: $ => seq(/[a-zA-Z_][a-zA-Z_0-9\.]*/, optional(", optional")),
    //
    element_description: $ => seq(
      seq(/[^\n]+/, '\n'),
      optional(repeat(seq(
        /\s{8}[^\n]+\n/,
      )))

    ),
    element_description_start: $ => seq(/[^\n]+/, '\n'),
    element_description_continuation: $ => seq(
      /\s{8}/,
      /[^\n]+/,
      '\n',
    ),

    ////////////////
    return_section: $ => seq(
      'Returns:\n',
      repeat($.return_line)
    ),
    return_line: $ => choice(
      /\s{4}[^\n]+\n/,
      '\n'),

    raises_section: $ => seq(
      'Raises:\n',
      repeat($.raise_info)
    ),
    raise_info: $ => seq(
      seq($.type_name,
        ':'),
      $.raise_description
    ),
    raise_description: $ => seq(
      seq(/[^\n]+/, '\n'),
      optional(repeat(seq(
        /\s{8}/,
        /[^\n]+/,
        '\n',
      )))

    ),
    examples_section: $ => seq(
      'Examples:\n',
      repeat($.example_line)
    ),
    example_line: $ => seq(/\s{4,}/, /[^\n]+/, '\n'),


    notes_section: $ => seq(
      'Notes:\n',
      repeat($.note_line)
    ),
    note_line: $ => seq(/\s{4,}/, /[^\n]+/, '\n'),

    attributes_section: $ => seq(
      'Attributes:\n',
      repeat($.attribute_line)
    ),
    attribute_line: $ => seq(/\s{4,}/, /[^\n]+/, '\n'),

  }
});