Add __eq__ to Indent

Author: domdfcoding

domdf_python_tools/stringlist.py

@@ -25,7 +25,7 @@
 
 # stdlib
 from contextlib import contextmanager
-from typing import Iterable, List, Tuple, Union, cast, overload
+from typing import Any, Iterable, Iterator, List, Tuple, Union, cast, overload
 
 # 3rd party
 from typing_extensions import Protocol
@@ -42,7 +42,7 @@ class String(Protocol):
 	"""
 
 	def __str__(self) -> str:
-		...
+		...  # pragma: no cover
 
 
 class Indent:
@@ -54,7 +54,7 @@ def __init__(self, size: int = 0, type: str = "\t"):
 		self.size = int(size)
 		self.type = str(type)
 
-	def __iter__(self) -> Iterable:
+	def __iter__(self) -> Iterator[Union[str, Any]]:
 		"""
 		Returns the size and type of the :class:`~domdf_python_tools.stringlist.Indent`
 		"""
@@ -102,6 +102,16 @@ def __repr__(self) -> str:
 
 		return f"{type(self).__name__}(size={self.size}, type={self.type!r})"
 
+	def __eq__(self, other):
+		if isinstance(other, Indent):
+			return other.size == self.size and other.type == self.type
+		elif isinstance(other, str):
+			return str(self) == other
+		elif isinstance(other, tuple):
+			return tuple(self) == other
+		else:
+			return NotImplemented
+
 
 class StringList(List[str]):
 	"""
@@ -132,7 +142,7 @@ def _make_line(self, line: str) -> str:
 		if not str(self.indent).strip(" \t") and self.convert_indents:
 			if self.indent_type == '\t':
 				line = convert_indents(line, tab_width=1, from_='    ', to='\t')
-			else:
+			else:  # pragma: no cover
 				line = convert_indents(line, tab_width=1, from_='\t', to=self.indent_type)
 
 		return f"{self.indent}{line}".rstrip()
@@ -192,7 +202,7 @@ def __setitem__(self, index: Union[int, slice], line: Union[String, Iterable[Str
 		elif isinstance(index, slice):
 			for line, index in zip(
 				reversed(line),  # type: ignore
-				reversed(range(index.start, index.stop + 1, index.step or 1)),
+				reversed(range(index.start or 0, index.stop + 1, index.step or 1)),
 				):
 				self[index] = line
 

tests/test_stringlist.py

@@ -5,7 +5,7 @@
 import pytest
 
 # this package
-from domdf_python_tools.stringlist import StringList
+from domdf_python_tools.stringlist import Indent, StringList
 
 
 class TestStringList:
@@ -235,6 +235,48 @@ def __repr__(self) -> str:
 		assert str(sl) == expected_string
 		assert sl == expected_string
 
+		sl = StringList()
+		sl.append("class Foo:")
+		sl.set_indent(Indent(0, "    "))
+		sl.blankline(True)
+
+		with sl.with_indent_size(1):
+			sl.append("def bar(self, listicle: List[Item]):")
+			with sl.with_indent_size(2):
+				sl.append("...")
+			sl.blankline(True)
+			sl.append("def __repr__(self) -> str:")
+			with sl.with_indent_size(2):
+				sl.append('return "Foo()"')
+			sl.blankline(True)
+
+		assert sl.indent_size == 0
+
+		assert sl == [x.expandtabs(4) for x in expected_list]
+		assert str(sl) == expected_string.expandtabs(4)
+		assert sl == expected_string.expandtabs(4)
+
+		sl = StringList()
+		sl.append("class Foo:")
+		sl.set_indent("    ", 0)
+		sl.blankline(True)
+
+		with sl.with_indent_size(1):
+			sl.append("def bar(self, listicle: List[Item]):")
+			with sl.with_indent_size(2):
+				sl.append("...")
+			sl.blankline(True)
+			sl.append("def __repr__(self) -> str:")
+			with sl.with_indent_size(2):
+				sl.append('return "Foo()"')
+			sl.blankline(True)
+
+		assert sl.indent_size == 0
+
+		assert sl == [x.expandtabs(4) for x in expected_list]
+		assert str(sl) == expected_string.expandtabs(4)
+		assert sl == expected_string.expandtabs(4)
+
 		sl = StringList()
 		sl.append("class Foo:")
 		sl.blankline(True)
@@ -263,3 +305,90 @@ def test_convert_indents(self):
 		sl.append("    Indented")
 
 		assert sl == ["\tIndented"]
+
+	def test_set_indent_error(self):
+		sl = StringList()
+		with pytest.raises(TypeError, match="'size' argument cannot be used when providing an 'Indent' object."):
+			sl.set_indent(Indent(0, "    "), 5)
+
+
+class TestIndent:
+
+	def test_creation(self):
+		indent = Indent()
+		assert indent.size == 0
+		assert indent.type == "\t"
+
+		indent = Indent(3, "    ")
+		assert indent.size == 3
+		assert indent.type == "    "
+
+	def test_iter(self):
+		indent = Indent(3, "    ")
+		assert tuple(indent) == (3, "    ")
+		assert list(iter(indent)) == [3, "    "]
+
+	def test_size(self):
+		indent = Indent()
+
+		indent.size = 1
+		assert indent.size == 1
+
+		indent.size = "2"  # type: ignore
+		assert indent.size == 2
+
+		indent.size = 3.0  # type: ignore
+		assert indent.size == 3
+
+	def test_type(self):
+		indent = Indent()
+
+		indent.type = "    "
+		assert indent.type == "    "
+
+		indent.type = " "
+		assert indent.type == " "
+
+		indent.type = 1  # type: ignore
+		assert indent.type == "1"
+
+		indent.type = ">>> "
+		assert indent.type == ">>> "
+
+		with pytest.raises(ValueError, match="'type' cannot an empty string."):
+			indent.type = ''
+
+	def test_str(self):
+		assert str(Indent()) == ""
+		assert str(Indent(1)) == "\t"
+		assert str(Indent(5)) == "\t\t\t\t\t"
+		assert str(Indent(type="    ")) == ""
+		assert str(Indent(1, type="    ")) == "    "
+		assert str(Indent(5, type="    ")) == "    " * 5
+		assert str(Indent(type=">>> ")) == ""
+		assert str(Indent(1, type=">>> ")) == ">>> "
+
+	def test_repr(self):
+		assert repr(Indent()) == "Indent(size=0, type='\\t')"
+		assert repr(Indent(1)) == "Indent(size=1, type='\\t')"
+		assert repr(Indent(5)) == "Indent(size=5, type='\\t')"
+		assert repr(Indent(type="    ")) == "Indent(size=0, type='    ')"
+		assert repr(Indent(1, type="    ")) == "Indent(size=1, type='    ')"
+		assert repr(Indent(5, type="    ")) == "Indent(size=5, type='    ')"
+		assert repr(Indent(type=">>> ")) == "Indent(size=0, type='>>> ')"
+		assert repr(Indent(1, type=">>> ")) == "Indent(size=1, type='>>> ')"
+
+	def test_eq(self):
+		assert Indent() == Indent()
+		assert Indent() == (0, "\t")
+		assert Indent() == ''
+
+		assert Indent(1, "    ") == Indent(1, "    ")
+		assert Indent(1, "    ") == (1, "    ")
+		assert Indent(1, "    ") == '    '
+
+		assert Indent(2, "\t") == Indent(2, "\t")
+		assert Indent(2, "\t") == (2, "\t")
+		assert Indent(2, "\t") == '\t\t'
+
+		assert not Indent() == 1