parse gets sections from doc Such as Args, Returns, Raises, Examples s Args: doc (string): is the astroid node doc string. Returns: True if doc is parsed successfully.
(self, doc)
| 53 | return level |
| 54 | |
| 55 | def parse(self, doc): |
| 56 | """parse gets sections from doc |
| 57 | Such as Args, Returns, Raises, Examples s |
| 58 | Args: |
| 59 | doc (string): is the astroid node doc string. |
| 60 | Returns: |
| 61 | True if doc is parsed successfully. |
| 62 | """ |
| 63 | self.clear() |
| 64 | |
| 65 | lines = doc.splitlines() |
| 66 | state = ("others", -1) |
| 67 | for l in lines: |
| 68 | c = l.strip() |
| 69 | if len(c) <= 0: |
| 70 | continue |
| 71 | |
| 72 | level = self.get_level(l) |
| 73 | if c.startswith("Args:"): |
| 74 | state = ("Args", level) |
| 75 | elif c.startswith("Returns:"): |
| 76 | state = ("Returns", level) |
| 77 | elif c.startswith("Raises:"): |
| 78 | state = ("Raises", level) |
| 79 | elif c.startswith("Examples:"): |
| 80 | state = ("Examples", level) |
| 81 | else: |
| 82 | if level > state[1]: |
| 83 | self.d[state[0]].append(c) |
| 84 | continue |
| 85 | |
| 86 | state = ("others", -1) |
| 87 | self.d[state[0]].append(c) |
| 88 | |
| 89 | self._arg_with_type() |
| 90 | return True |
| 91 | |
| 92 | def get_returns(self): |
| 93 | return self.d['Returns'] |
no test coverage detected