Added type annotations

Author: joachimmetz

.gitignore

@@ -21,6 +21,9 @@
 # Pycharm files
 /.idea
 
+# Type check files
+/.mypy_cache
+
 # Test coverage files
 .coverage
 tests-coverage.txt

.travis.yml

@@ -5,7 +5,7 @@ dist: bionic
 jobs:
   include:
   - name: "Pylint on Ubuntu Bionic (20.04) (Docker) with Python 3.8"
-    env: [TARGET="pylint", UBUNTU_VERSION="20.04"]
+    env: [TARGET="lint_and_type_check", UBUNTU_VERSION="20.04"]
     group: edge
     language: python
     python: 3.8
@@ -39,13 +39,6 @@ jobs:
     python: 3.8
     services:
     - docker
-  - name: "Ubuntu Focal (20.04) (Docker) with Python 3.5 (tox)"
-    env: [TOXENV="py35", UBUNTU_VERSION="20.04"]
-    group: edge
-    language: python
-    python: 3.5
-    services:
-    - docker
   - name: "Ubuntu Focal (20.04) (Docker) with Python 3.6 (tox)"
     env: [TOXENV="py36", UBUNTU_VERSION="20.04"]
     group: edge

config/dpkg/changelog

@@ -1,5 +1,5 @@
-dfdatetime (20200501-1) unstable; urgency=low
+dfdatetime (20200601-1) unstable; urgency=low
 
   * Auto-generated
 
- -- Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com>  Fri, 01 May 2020 13:44:09 +0200
+ -- Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com>  Mon, 01 Jun 2020 07:47:13 +0200

config/dpkg/control

@@ -2,9 +2,9 @@ Source: dfdatetime
 Section: python
 Priority: extra
 Maintainer: Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com>
-Build-Depends: debhelper (>= 9), dh-python, python3-all (>= 3.5~), python3-setuptools
+Build-Depends: debhelper (>= 9), dh-python, python3-all (>= 3.6~), python3-setuptools
 Standards-Version: 4.1.4
-X-Python3-Version: >= 3.5
+X-Python3-Version: >= 3.6
 Homepage: https://github.com/log2timeline/dfdatetime
 
 Package: python3-dfdatetime

config/travis/install.sh

@@ -37,9 +37,9 @@ then
 	else
 		RPM_PACKAGES="";
 
-		if test ${TARGET} = "pylint";
+		if test ${TARGET} = "lint_and_type_check";
 		then
-			RPM_PACKAGES="${RPM_PACKAGES} findutils pylint";
+			RPM_PACKAGES="${RPM_PACKAGES} findutils pylint python3-mypy";
 		fi
 		RPM_PACKAGES="${RPM_PACKAGES} python3 ${RPM_PYTHON3_DEPENDENCIES} ${RPM_PYTHON3_TEST_DEPENDENCIES}";
 	fi
@@ -87,9 +87,9 @@ then
 		then
 			DPKG_PACKAGES="${DPKG_PACKAGES} sudo";
 
-		elif test ${TARGET} = "pylint";
+		elif test ${TARGET} = "lint_and_type_check";
 		then
-			DPKG_PACKAGES="${DPKG_PACKAGES} python3-distutils pylint";
+			DPKG_PACKAGES="${DPKG_PACKAGES} mypy pylint python3-distutils";
 		fi
 		if test "${TARGET}" != "jenkins3";
 		then

config/travis/run_pylint.sh config/travis/run_checks.shconfig/travis/run_pylint.sh renamed to config/travis/run_checks.sh

@@ -1,12 +1,14 @@
 #!/bin/bash
 #
-# Script to run pylint on Travis-CI.
+# Script to run lint and type checks on Travis-CI.
 #
 # This file is generated by l2tdevtools update-dependencies.py, any dependency
 # related changes should be made in dependencies.ini.
 
-# Exit on error.
-set -e;
+EXIT_SUCCESS=0;
+EXIT_FAILURE=1;
+
+RESULT=${EXIT_SUCCESS};
 
 pylint --version
 
@@ -19,4 +21,20 @@ do
 	echo "Checking: ${FILE}";
 
 	pylint --rcfile=.pylintrc ${FILE};
+
+	if test $? -ne ${EXIT_SUCCESS};
+	then
+		RESULT=${EXIT_FAILURE};
+	fi
 done
+
+mypy --version
+
+mypy --strict dfdatetime;
+
+if test $? -ne ${EXIT_SUCCESS};
+then
+	RESULT=${EXIT_FAILURE};
+fi
+
+exit ${RESULT};

config/travis/runtests.sh

@@ -17,9 +17,9 @@ then
 	then
 		TEST_COMMAND="tox -e ${TOXENV}";
 
-	elif test "${TARGET}" = "pylint";
+	elif test "${TARGET}" = "lint_and_type_check";
 	then
-		TEST_COMMAND="./config/travis/run_pylint.sh";
+		TEST_COMMAND="./config/travis/run_checks.sh";
 	else
 		TEST_COMMAND="./config/travis/run_python3.sh";
 	fi
@@ -51,9 +51,9 @@ then
 	then
 		TEST_COMMAND="./config/jenkins/linux/run_end_to_end_tests_py3.sh travis";
 
-	elif test "${TARGET}" = "pylint";
+	elif test "${TARGET}" = "lint_and_type_check";
 	then
-		TEST_COMMAND="./config/travis/run_pylint.sh";
+		TEST_COMMAND="./config/travis/run_checks.sh";
 	else
 		TEST_COMMAND="./config/travis/run_python3.sh";
 	fi

dfdatetime/__init__.py

@@ -5,4 +5,4 @@
 objects to preserve accuracy and precision.
 """
 
-__version__ = '20200501'
+__version__ = '20200601'

dfdatetime/apfs_time.py

@@ -5,6 +5,8 @@
 
 import decimal
 
+from typing import Union  # pylint: disable=unused-import
+
 from dfdatetime import definitions
 from dfdatetime import posix_time
 
@@ -19,14 +21,14 @@ class APFSTime(posix_time.PosixTimeInNanoseconds):
     is_local_time (bool): True if the date and time value is in local time.
   """
 
-  def _GetNormalizedTimestamp(self):
+  def _GetNormalizedTimestamp(self) -> 'Union[decimal.Decimal, None]':
     """Retrieves the normalized timestamp.
 
     Returns:
       decimal.Decimal: normalized timestamp, which contains the number of
-          seconds since January 1, 1970 00:00:00 and a fraction of second used
-          for increased precision, or None if the normalized timestamp cannot be
-          determined.
+          seconds since January 1, 1970 00:00:00 and a fraction of second
+          used for increased precision, or None if the normalized timestamp
+          cannot be determined.
     """
     if self._normalized_timestamp is None:
       if (self._timestamp is not None and self._timestamp >= self._INT64_MIN and
@@ -37,7 +39,7 @@ def _GetNormalizedTimestamp(self):
 
     return self._normalized_timestamp
 
-  def CopyFromDateTimeString(self, time_string):
+  def CopyFromDateTimeString(self, time_string: 'str') -> 'None':
     """Copies a APFS timestamp from a date and time string.
 
     Args:
@@ -58,7 +60,7 @@ def CopyFromDateTimeString(self, time_string):
         self._timestamp > self._INT64_MAX):
       raise ValueError('Date time value not supported.')
 
-  def CopyToDateTimeString(self):
+  def CopyToDateTimeString(self) -> 'Union[str, None]':
     """Copies the APFS timestamp to a date and time string.
 
     Returns:

dfdatetime/cocoa_time.py

@@ -5,14 +5,16 @@
 
 import decimal
 
+from typing import Optional, Union  # pylint: disable=unused-import
+
 from dfdatetime import definitions
 from dfdatetime import interface
 
 
 class CocoaTimeEpoch(interface.DateTimeEpoch):
   """Cocoa time epoch."""
 
-  def __init__(self):
+  def __init__(self) -> 'None':
     """Initializes a Cocoa time epoch."""
     super(CocoaTimeEpoch, self).__init__(2001, 1, 1)
 
@@ -32,32 +34,33 @@ class CocoaTime(interface.DateTimeValues):
     is_local_time (bool): True if the date and time value is in local time.
   """
   # The difference between January 1, 2001 and January 1, 1970 in seconds.
-  _COCOA_TO_POSIX_BASE = -978307200
+  _COCOA_TO_POSIX_BASE: 'int' = -978307200
 
-  _EPOCH = CocoaTimeEpoch()
+  _EPOCH: 'interface.DateTimeEpoch' = CocoaTimeEpoch()
 
-  def __init__(self, timestamp=None):
+  def __init__(self, timestamp: 'Optional[float]' = None) -> 'None':
     """Initializes a Cocoa timestamp.
 
     Args:
       timestamp (Optional[float]): Cocoa timestamp.
     """
     super(CocoaTime, self).__init__()
-    self._precision = definitions.PRECISION_1_SECOND
-    self._timestamp = timestamp
+    self._precision: 'str' = definitions.PRECISION_1_SECOND
+    self._timestamp: 'Union[float, None]' = timestamp
 
   @property
-  def timestamp(self):
+  def timestamp(self) -> 'Union[float, None]':
     """float: Cocoa timestamp or None if timestamp is not set."""
     return self._timestamp
 
-  def _GetNormalizedTimestamp(self):
+  def _GetNormalizedTimestamp(self) -> 'Union[decimal.Decimal, None]':
     """Retrieves the normalized timestamp.
 
     Returns:
-      float: normalized timestamp, which contains the number of seconds since
-          January 1, 1970 00:00:00 and a fraction of second used for increased
-          precision, or None if the normalized timestamp cannot be determined.
+      decimal.Decimal: normalized timestamp, which contains the number of
+          seconds since January 1, 1970 00:00:00 and a fraction of second
+          used for increased precision, or None if the normalized timestamp
+          cannot be determined.
     """
     if self._normalized_timestamp is None:
       if self._timestamp is not None:
@@ -66,7 +69,7 @@ def _GetNormalizedTimestamp(self):
 
     return self._normalized_timestamp
 
-  def CopyFromDateTimeString(self, time_string):
+  def CopyFromDateTimeString(self, time_string: 'str') -> 'None':
     """Copies a Cocoa timestamp from a date and time string.
 
     Args:
@@ -92,19 +95,20 @@ def CopyFromDateTimeString(self, time_string):
     microseconds = date_time_values.get('microseconds', None)
     time_zone_offset = date_time_values.get('time_zone_offset', 0)
 
-    timestamp = self._GetNumberOfSecondsFromElements(
-        year, month, day_of_month, hours, minutes, seconds, time_zone_offset)
-    timestamp += self._COCOA_TO_POSIX_BASE
+    number_of_seconds = self._GetNumberOfSecondsFromElements(
+        year, month, day_of_month, hours, minutes, seconds,
+        time_zone_offset=time_zone_offset)
+    number_of_seconds += self._COCOA_TO_POSIX_BASE
 
-    timestamp = float(timestamp)
+    timestamp = float(number_of_seconds)
     if microseconds is not None:
       timestamp += float(microseconds) / definitions.MICROSECONDS_PER_SECOND
 
     self._normalized_timestamp = None
     self._timestamp = timestamp
     self._time_zone_offset = time_zone_offset
 
-  def CopyToDateTimeString(self):
+  def CopyToDateTimeString(self) -> 'Union[str, None]':
     """Copies the Cocoa timestamp to a date and time string.
 
     Returns: