Fixed issue where idents were being stripped from the start of lines in StringList, and added some missing methods.

Author: domdfcoding

domdf_python_tools/stringlist.py

@@ -28,14 +28,15 @@
 from typing import Any, Iterable, Iterator, List, Tuple, Union, cast, overload
 
 # 3rd party
-from typing_extensions import Protocol
+from typing_extensions import Protocol, runtime_checkable
 
 # this package
 from domdf_python_tools.utils import convert_indents
 
 __all__ = ["String", "Indent", "StringList"]
 
 
+@runtime_checkable
 class String(Protocol):
 	"""
 	Protocol for classes that implement ``__str__``.
@@ -134,12 +135,12 @@ def __init__(self, iterable: Iterable[String] = (), convert_indents: bool = Fals
 		if isinstance(iterable, str):
 			iterable = iterable.split("\n")
 
-		super().__init__([str(x).strip() for x in iterable])
 		self.indent = Indent()
 		self.convert_indents = convert_indents
+		super().__init__([self._make_line(str(x)) for x in iterable])
 
 	def _make_line(self, line: str) -> str:
-		if not str(self.indent).strip(" \t") and self.convert_indents:
+		if not str(self.indent_type).strip(" \t") and self.convert_indents:
 			if self.indent_type == '\t':
 				line = convert_indents(line, tab_width=1, from_='    ', to='\t')
 			else:  # pragma: no cover
@@ -149,17 +150,44 @@ def _make_line(self, line: str) -> str:
 
 	def append(self, line: String) -> None:
 		"""
-		Append a line to the end of the StringList.
+		Append a line to the end of the :class:`~domdf_python_tools.stringlist.StringList`.
 
 		:param line:
 		"""
 
 		for inner_line in str(line).split("\n"):
 			super().append(self._make_line(inner_line))
 
+	def extend(self, iterable: Iterable[String]) -> None:
+		"""
+		Extend the :class:`~domdf_python_tools.stringlist.StringList` with lines from ``iterable``.
+
+		:param iterable: An iterable of string-like objects to add to the end of the
+			:class:`~domdf_python_tools.stringlist.StringList`.
+		"""
+
+		for line in iterable:
+			self.append(line)
+
+	def copy(self) -> "StringList":
+		"""
+		Returns a shallow copy of the :class:`~domdf_python_tools.stringlist.StringList`.
+
+		Equivalent to ``a[:]``.
+		"""
+
+		return self.__class__(super().copy())
+
+	def count_blanklines(self) -> int:
+		"""
+		Returns a count of the blank lines in the :class:`~domdf_python_tools.stringlist.StringList`.
+		"""
+
+		return self.count('')
+
 	def insert(self, index: int, line: String) -> None:
 		"""
-		Insert a line into the StringList at the given position.
+		Insert a line into the :class:`~domdf_python_tools.stringlist.StringList` at the given position.
 
 		:param index:
 		:param line:
@@ -240,7 +268,7 @@ def set_indent_size(self, size: int = 0):
 		"""
 		Sets the size of the indent to insert at the beginning of new lines.
 
-		:param size:
+		:param size: The indent size to use for new lines.
 		"""
 
 		self.indent.size = int(size)
@@ -249,7 +277,7 @@ def set_indent_type(self, indent_type: str = "\t"):
 		"""
 		Sets the type of the indent to insert at the beginning of new lines.
 
-		:param indent_type:
+		:param indent_type: The type of indent to use for new lines.
 		"""
 
 		self.indent.type = str(indent_type)
@@ -258,8 +286,8 @@ def set_indent(self, indent: Union[String, Indent], size: int = 0):
 		"""
 		Sets the indent to insert at the beginning of new lines.
 
-		:param indent:
-		:param size:
+		:param indent: The :class:`~.Indent` to use for new lines, or the indent type.
+		:param size: If ``indent`` is an indent type, the indent size to use for new lines.
 		"""
 
 		if isinstance(indent, Indent):
@@ -330,8 +358,8 @@ def with_indent(self, indent: Union[String, Indent], size: int = 0):
 			>>> with sl.with_indent("    ", 1):
 			...     sl.append("Hello World")
 
-		:param indent:
-		:param size:
+		:param indent: The :class:`~.Indent` to use within the ``with`` block, or the indent type.
+		:param size: If ``indent`` is an indent type, the indent size to use within the ``with`` block.
 		"""
 
 		original_indent: Tuple[int, str] = tuple(self.indent)  # type: ignore
@@ -353,7 +381,7 @@ def with_indent_size(self, size: int = 0):
 			>>> with sl.with_indent_size(1):
 			...     sl.append("Hello World")
 
-		:param size:
+		:param size: The indent size to use within the ``with`` block.
 		"""
 
 		original_indent_size = self.indent_size
@@ -375,7 +403,7 @@ def with_indent_type(self, indent_type: str = "\t"):
 			>>> with sl.with_indent_type("    "):
 			...     sl.append("Hello World")
 
-		:param indent_type:
+		:param indent_type: The type of indent to use within the ``with`` block.
 		"""
 
 		original_indent_type = self.indent_type

tests/test_stringlist.py

@@ -91,6 +91,32 @@ def test_blankline(self):
 		sl.blankline(ensure_single=True)
 		assert sl == ["", '', "hello", "world", '', '', '', "1234", '']
 
+		sl.blankline(ensure_single=True)
+		assert sl == ["", '', "hello", "world", '', '', '', "1234", '']
+
+		sl.append("\t")
+		sl.blankline(ensure_single=True)
+		assert sl == ["", '', "hello", "world", '', '', '', "1234", '']
+
+		sl.append("    ")
+		sl.blankline(ensure_single=True)
+
+		assert sl == ["", '', "hello", "world", '', '', '', "1234", '']
+
+		sl.append("    ")
+		sl.blankline(ensure_single=True)
+		sl.blankline()
+		assert sl == ["", '', "hello", "world", '', '', '', "1234", '', '']
+
+	def test_slicing(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		assert sl[:-3] == ["", '', "hello", "world", '']
+		assert sl[-3:] == ['', '', "1234"]
+
+	def test_start_of_line_indents(self):
+		assert StringList("Hello\n    World") == ["Hello", "    World"]
+		assert StringList("Hello\n    World", convert_indents=True) == ["Hello", "\tWorld"]
+
 	def test_indent_size(self):
 		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
 
@@ -392,3 +418,64 @@ def test_eq(self):
 		assert Indent(2, "\t") == '\t\t'
 
 		assert not Indent() == 1
+
+	def test_extend(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		sl.extend(["\nfoo\nbar\n    baz"])
+
+		assert sl == ["", '', "hello", "world", '', '', '', "1234", '', "foo", "bar", "    baz"]
+
+	def test_clear(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		sl.clear()
+
+		assert sl == []
+
+	def test_copy(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		sl2 = sl.copy()
+
+		assert sl == sl2
+		assert sl2 == ["", '', "hello", "world", '', '', '', "1234"]
+		assert isinstance(sl2, StringList)
+
+	def test_count(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		assert sl.count("hello") == 1
+
+	def test_count_blanklines(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		assert sl.count_blanklines() == 5
+
+	def test_index(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		assert sl.index("hello") == 2
+
+	def test_pop(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		assert sl.pop(2) == "hello"
+		assert sl == ["", '', "world", '', '', '', "1234"]
+		assert isinstance(sl, StringList)
+
+	def test_remove(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		sl.remove("hello")
+		assert sl == ["", '', "world", '', '', '', "1234"]
+		assert isinstance(sl, StringList)
+
+	def test_reverse(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		sl.reverse()
+		assert sl == ["1234", '', '', '', "world", "hello", '', '']
+		assert isinstance(sl, StringList)
+
+	def test_sort(self):
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		sl.sort()
+		assert sl == ['', '', '', '', '', "1234", "hello", "world"]
+		assert isinstance(sl, StringList)
+
+		sl = StringList(["", '', "hello", "world", '', '', '', "1234"])
+		sl.sort(reverse=True)
+		assert sl == ["world", "hello", "1234", '', '', '', '', '']
+		assert isinstance(sl, StringList)