It is possible that a user component class's docstring has no lines or a
single one, for example:
# no line
class MySink(bt2._UserSinkComponent):
""""""
def _user_consume(self):
pass
# single line
class MySink(bt2._UserSinkComponent):
"""The single line"""
def _user_consume(self):
pass
The previous version of _trim_docstring() expects this format:
class MySink(bt2._UserSinkComponent):
"""
My sink's description
Dolore officia ex et aliquip eiusmod enim pariatur reprehenderit
ad adipisicing non occaecat ullamco aliquip laborum duis
proident ex duis.
Irure commodo proident esse non pariatur in aute cillum id aute.
"""
def _user_consume(self):
pass
In _trim_docstring(), accept no lines or a single one.
Adding new tests to `test_component_class.py` to validate this
behaviour. The
# fmt: off
"""
"""
# fmt: on
docstring has off/on formatting markers as Black 20.8b1 transforms this
into the non-equivalent
""""""
(which is another test now).
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Ia12b0e9bfd4d1e1aaa86f0c8c207c3c1535f5c3e
Reviewed-on: https://review.lttng.org/c/babeltrace/+/4072
def _trim_docstring(docstring):
lines = docstring.expandtabs().splitlines()
def _trim_docstring(docstring):
lines = docstring.expandtabs().splitlines()
+
+ if len(lines) == 0:
+ return ''
+
- for line in lines[1:]:
- stripped = line.lstrip()
+ if len(lines) > 1:
+ for line in lines[1:]:
+ stripped = line.lstrip()
- if stripped:
- indent = min(indent, len(line) - len(stripped))
+ if stripped:
+ indent = min(indent, len(line) - len(stripped))
trimmed = [lines[0].strip()]
trimmed = [lines[0].strip()]
- if indent < sys.maxsize:
+ if indent < sys.maxsize and len(lines) > 1:
for line in lines[1:]:
trimmed.append(line[indent:].rstrip())
for line in lines[1:]:
trimmed.append(line[indent:].rstrip())
self.assertEqual(MySink.description, 'The description.')
self.assertEqual(MySink.description, 'The description.')
- def test_empty_description(self):
+ def test_empty_description_no_lines(self):
class MySink(bt2._UserSinkComponent):
class MySink(bt2._UserSinkComponent):
+ # fmt: off
+ """"""
+ # fmt: on
+
+ def _user_consume(self):
+ pass
+
+ self.assertIsNone(MySink.description)
+
+ def test_empty_description_no_contents(self):
+ class MySink(bt2._UserSinkComponent):
+ # fmt: off
def _user_consume(self):
pass
self.assertIsNone(MySink.description)
def _user_consume(self):
pass
self.assertIsNone(MySink.description)
+ def test_empty_description_single_line(self):
+ class MySink(bt2._UserSinkComponent):
+ """my description"""
+
+ def _user_consume(self):
+ pass
+
+ self.assertEqual(MySink.description, "my description")
+
def test_help(self):
class MySink(bt2._UserSinkComponent):
"""
def test_help(self):
class MySink(bt2._UserSinkComponent):
"""