Updating type hints.

Author: domdfcoding

domdf_python_tools/bases.py

@@ -52,7 +52,7 @@ def __getstate__(self) -> Dict[str, Any]:
 		return self.__dict__
 
 	def __setstate__(self, state):
-		self.__init__(**state)
+		self.__init__(**state)  # type: ignore
 
 	def __copy__(self):
 		return self.__class__(**self.__dict__)

domdf_python_tools/doctools.py

@@ -34,7 +34,7 @@
 F = TypeVar('F', bound=Callable[..., Any])
 
 
-def deindent_string(string: str) -> str:
+def deindent_string(string: Optional[str]) -> str:
 	"""
 	Removes all indentation from the given string.
 
@@ -45,6 +45,10 @@ def deindent_string(string: str) -> str:
 	:rtype: str
 	"""
 
+	if not string:
+		# Short circuit if empty string or None
+		return ''
+
 	split_string = string.split("\n")
 	deindented_string = [line.lstrip("\t ") for line in split_string]
 	return "\n".join(deindented_string)

domdf_python_tools/paths.py

@@ -282,7 +282,7 @@ class PathPlus(pathlib.Path):
 	def __new__(cls, *args, **kwargs):
 		if cls is PathPlus:
 			cls = WindowsPathPlus if os.name == 'nt' else PosixPathPlus
-		self = cls._from_parts(args, init=False)
+		self = cls._from_parts(args, init=False)  # type: ignore
 		if not self._flavour.is_supported:
 			raise NotImplementedError(f"cannot instantiate {cls.__name__!r} on your system")
 		self._init()

domdf_python_tools/terminal.py

@@ -67,9 +67,8 @@
 import shlex
 import struct
 import subprocess
-import sys
 import textwrap
-from typing import Optional, Tuple
+from typing import Any, Optional, Tuple
 
 
 def clear() -> None:
@@ -208,13 +207,15 @@ def _get_terminal_size_posix() -> Optional[Tuple[int, int]]:  # pragma: no cover
 	import fcntl
 	import termios
 
-	def ioctl_GWINSZ(fd):
+	def ioctl_GWINSZ(fd: int) -> Optional[Tuple[Any, ...]]:
 		try:
-			cr = struct.unpack("hh", fcntl.ioctl(fd, termios.TIOCGWINSZ, "1234"))
+			cr = struct.unpack("hh", fcntl.ioctl(fd, termios.TIOCGWINSZ, b"1234"))
 			return cr
 		except Exception:
 			pass
 
+		return None
+
 	cr = ioctl_GWINSZ(0) or ioctl_GWINSZ(1) or ioctl_GWINSZ(2)
 
 	if not cr:
@@ -252,10 +253,15 @@ def __init__(self, indent: str = "  "):
 			self.parent_frame = inspect.currentframe().f_back  # type: ignore  # TODO
 
 	def __enter__(self):
-		self.locals_on_entry = self.parent_frame.f_locals.copy()
+		self.locals_on_entry = self.parent_frame.f_locals.copy()  # type: ignore
 
 	def __exit__(self, exc_t, exc_v, tb):
-		new_locals = {k: v for k, v in self.parent_frame.f_locals.items() if k not in self.locals_on_entry}
+		new_locals = {
+				k: v
+				for k, v in self.parent_frame.f_locals.items()   # type: ignore
+				if k not in self.locals_on_entry
+				}
+
 		print(textwrap.indent(pprint.pformat(new_locals), self.indent))
 
 

domdf_python_tools/typing.py

@@ -31,7 +31,7 @@
 PathLike = Union[str, pathlib.Path, os.PathLike]
 
 
-def check_membership(obj: Any, type_: Type) -> bool:
+def check_membership(obj: Any, type_: Union[Type, object]) -> bool:
 	"""
 	Check if the type of ``obj`` is one of the types in a :class:`typing.Union`, Sequence etc.
 

setup.cfg

@@ -49,3 +49,12 @@ exclude =
     tests
     tests.*
     doc-source
+
+
+
+
+[mypy]
+python_version = 3.6
+ignore_missing_imports = True
+namespace_packages = True
+check_untyped_defs = True

tests/test_dates.py

@@ -19,6 +19,7 @@
 test_date = datetime.datetime(1996, 10, 13, 2, 20).replace(tzinfo=pytz.utc)
 today = datetime.datetime.utcnow().replace(tzinfo=pytz.utc)  # make sure UTC
 
+
 # TODO: travis matrix to test without pytz installed
 # TODO: test get_timezone
 
@@ -78,13 +79,21 @@ def test_set_timezone():
 
 		if dates.get_utc_offset(tz, today):  # otherwise the timezone stayed as UTC
 			# ensure timestamp did change
-			assert dates.set_timezone(today, dates.get_timezone(tz, today)).timestamp() != today.timestamp()
+			target_tz = dates.get_timezone(tz, today)
+			assert target_tz is not None
+
+			assert dates.set_timezone(today, target_tz).timestamp() != today.timestamp()
 
 			# Difference between "today" and the new timezone should be the timezone difference
-			assert (
-					dates.set_timezone(today, dates.get_timezone(tz, today)).timestamp()
-					+ dates.get_utc_offset(tz, today).total_seconds()
-					) == today.timestamp()
+			target_tz = dates.get_timezone(tz, today)
+			assert target_tz is not None
+
+			utc_offset = dates.get_utc_offset(tz, today)
+			assert utc_offset is not None
+
+			as_seconds = dates.set_timezone(today, target_tz).timestamp() + utc_offset.total_seconds()
+
+			assert as_seconds == today.timestamp()
 
 		if tz in {
 				"America/Punta_Arenas",
@@ -110,10 +119,14 @@ def test_set_timezone():
 			# 		get_utc_offset(tz, test_date).total_seconds()
 			#
 			# 		)
-			assert (
-					dates.set_timezone(test_date, dates.get_timezone(tz, test_date)).timestamp()
-					+ dates.get_utc_offset(tz, test_date).total_seconds()
-					) == test_date.timestamp()
+			target_tz = dates.get_timezone(tz, test_date)
+			assert target_tz is not None
+
+			offset = dates.get_utc_offset(tz, test_date)
+			assert offset is not None
+
+			as_seconds = dates.set_timezone(test_date, target_tz).timestamp() + offset.total_seconds()
+			assert as_seconds == test_date.timestamp()
 
 
 months = [
@@ -146,31 +159,39 @@ def test_parse_month():
 
 	for value in ["abc", 0, '0', -1, "-1", 13, "13"]:
 		with pytest.raises(ValueError, match="Unrecognised month value"):
-			dates.parse_month(value)
+			dates.parse_month(value)  # type: ignore
 
 
-def test_get_month_number():
-	for month_idx, month in enumerate(months):
+@pytest.mark.parametrize("month_idx, month", enumerate(months))
+def test_get_month_number_from_name(month_idx, month):
+	month_idx += 1  # to make 1-indexed
 
-		month_idx += 1  # to make 1-indexed
+	for i in range(3, len(month)):
+		assert dates.get_month_number(month.lower()[:i]) == month_idx
+		assert dates.get_month_number(month.upper()[:i]) == month_idx
+		assert dates.get_month_number(month.capitalize()[:i]) == month_idx
 
-		for i in range(3, len(month)):
-			assert dates.get_month_number(month.lower()[:i]) == month_idx
-			assert dates.get_month_number(month.upper()[:i]) == month_idx
-			assert dates.get_month_number(month.capitalize()[:i]) == month_idx
+	assert dates.get_month_number(month) == month_idx
 
-		assert dates.get_month_number(month) == month_idx
 
+@pytest.mark.parametrize("month_idx", range(1, 13))
+def test_get_month_number_from_no(month_idx):
 	for month_idx in range(1, 13):
 		assert dates.get_month_number(month_idx) == month_idx
 
-	for value in [0, -1, 13]:
-		with pytest.raises(ValueError, match="The given month is not recognised."):
-			dates.get_month_number(value)
 
-	for value in ["abc", '0', "-1" "13"]:
-		with pytest.raises(ValueError, match="Unrecognised month value"):
-			dates.get_month_number(value)
+@pytest.mark.parametrize("value, match", [
+		(0, "The given month is not recognised."),
+		(-1, "The given month is not recognised."),
+		(13, "The given month is not recognised."),
+		("abc", "Unrecognised month value"),
+		('0', "Unrecognised month value"),
+		("-1", "Unrecognised month value"),
+		("13", "Unrecognised month value"),
+		])
+def test_get_month_number_errors(value, match):
+	with pytest.raises(ValueError, match=match):
+		dates.get_month_number(value)
 
 
 def test_check_date():

tests/test_import_tools.py

@@ -13,7 +13,7 @@
 sys.path.append("tests")
 
 # 3rd party
-import discover_demo_module
+import discover_demo_module  # type: ignore
 
 
 def test_discover():

tests/test_paths.py

@@ -147,8 +147,8 @@ def test_maybe_make_parents_pathplus():
 
 
 def test_parent_path():
-	with TemporaryDirectory() as tmpdir:
-		tmpdir = pathlib.Path(tmpdir)
+	with TemporaryDirectory() as tmpdir_:
+		tmpdir = pathlib.Path(tmpdir_)
 
 		dir1 = tmpdir / "dir1"
 		dir2 = dir1 / "dir2"

tests/test_paths_stdlib.py

@@ -8,20 +8,17 @@
 #
 
 # stdlib
-import collections.abc
 import errno
-import io
 import os
 import pathlib
 import pickle
-import platform
 import socket
 import stat
 import sys
-import tempfile
 import unittest
 from test import support  # type: ignore
 from test.support import TESTFN  # type: ignore
+from typing import Set
 from unittest import mock
 
 # 3rd party
@@ -44,7 +41,7 @@
 
 
 def symlink_skip_reason():
-	if not pathlib.supports_symlinks:
+	if not pathlib.supports_symlinks:  # type: ignore
 		return "no system support for symlinks"
 	try:
 		os.symlink(__file__, BASE)
@@ -243,7 +240,7 @@ def test_unlink(self):
 	def test_unlink_missing_ok(self):  # pragma: no cover (<py37)
 		p = PathPlus(BASE) / 'fileAAA'
 		self.assertFileNotFound(p.unlink)
-		p.unlink(missing_ok=True)
+		p.unlink(missing_ok=True)  # type: ignore
 
 	def test_rmdir(self):
 		p = PathPlus(BASE) / 'dirA'
@@ -262,15 +259,15 @@ def test_link_to(self):  # pragma: no cover (<py37)
 		# linking to another path.
 		q = P / 'dirA' / 'fileAA'
 		try:
-			p.link_to(q)
+			p.link_to(q)  # type: ignore
 		except PermissionError as e:
 			self.skipTest('os.link(): %s' % e)
 		self.assertEqual(q.stat().st_size, size)
 		self.assertEqual(os.path.samefile(p, q), True)
 		self.assertTrue(p.stat)
 		# Linking to a str of a relative path.
 		r = rel_join('fileAAA')
-		q.link_to(r)
+		q.link_to(r)  # type: ignore
 		self.assertEqual(os.stat(r).st_size, size)
 		self.assertTrue(q.stat)
 
@@ -281,7 +278,7 @@ def test_link_to_not_implemented(self):
 		# linking to another path.
 		q = P / 'dirA' / 'fileAA'
 		with self.assertRaises(NotImplementedError):
-			p.link_to(q)
+			p.link_to(q)  # type: ignore
 
 	def test_rename(self):
 		P = PathPlus(BASE)
@@ -347,11 +344,11 @@ def test_replace(self):
 	@with_symlinks
 	def test_readlink(self):  # pragma: no cover (<py39)
 		P = PathPlus(BASE)
-		self.assertEqual((P / 'linkA').readlink(), PathPlus('fileA'))
-		self.assertEqual((P / 'brokenLink').readlink(), PathPlus('non-existing'))
-		self.assertEqual((P / 'linkB').readlink(), PathPlus('dirB'))
+		self.assertEqual((P / 'linkA').readlink(), PathPlus('fileA'))  # type: ignore
+		self.assertEqual((P / 'brokenLink').readlink(), PathPlus('non-existing'))  # type: ignore
+		self.assertEqual((P / 'linkB').readlink(), PathPlus('dirB'))  # type: ignore
 		with self.assertRaises(OSError):
-			(P / 'fileA').readlink()
+			(P / 'fileA').readlink()  # type: ignore
 
 	def test_touch_common(self):
 		P = PathPlus(BASE)
@@ -507,7 +504,7 @@ def my_mkdir(path, mode=0o777):
 				os.mkdir(path, mode)  # Our real call.
 
 			pattern = [bool(pattern_num & (1 << n)) for n in range(5)]
-			concurrently_created = set()
+			concurrently_created: Set = set()
 			p12 = p / 'dir1' / 'dir2'
 			try:
 				with mock.patch("pathlib._normal_accessor.mkdir", my_mkdir):
@@ -569,13 +566,13 @@ def test_is_file(self):
 	def test_is_mount(self):  # pragma: no cover (<py37)
 		P = PathPlus(BASE)
 		R = PathPlus('/')  # TODO: Work out Windows.
-		self.assertFalse((P / 'fileA').is_mount())
-		self.assertFalse((P / 'dirA').is_mount())
-		self.assertFalse((P / 'non-existing').is_mount())
-		self.assertFalse((P / 'fileA' / 'bah').is_mount())
-		self.assertTrue(R.is_mount())
+		self.assertFalse((P / 'fileA').is_mount())  # type: ignore
+		self.assertFalse((P / 'dirA').is_mount())  # type: ignore
+		self.assertFalse((P / 'non-existing').is_mount())  # type: ignore
+		self.assertFalse((P / 'fileA' / 'bah').is_mount())  # type: ignore
+		self.assertTrue(R.is_mount())  # type: ignore
 		if support.can_symlink():
-			self.assertFalse((P / 'linkA').is_mount())
+			self.assertFalse((P / 'linkA').is_mount())  # type: ignore
 
 	def test_is_symlink(self):
 		P = PathPlus(BASE)