Linting and updated copyright

Author: domdfcoding

.travis.yml

@@ -5,9 +5,9 @@ python:
 - '3.7'
 - "3.8"
 install:
-- pip install -U coveralls pytest pytz
+- pip install coveralls -r tests/requirements.txt
 script:
-- coverage run --source=domdf_python_tools -m pytest
+- pytest --cov=sdjson tests/
 after_success:
 - coveralls
 deploy:

domdf_python_tools/__init__.py

@@ -1,4 +1,4 @@
-#  Compiled 2018-2019 by Dominic Davis-Foster <[email protected]>
+#  Compiled 2018-2020 by Dominic Davis-Foster <[email protected]>
 #
 #  terminal.py
 #  		Copyright © 2014-2019 Dominic Davis-Foster <[email protected]>
@@ -8,7 +8,7 @@
 #  			Copyright © 2011 jtriley
 #
 #  paths.py
-# 		Copyright © 2018-2019 Dominic Davis-Foster <[email protected]>
+# 		Copyright © 2018-2020 Dominic Davis-Foster <[email protected]>
 #
 #  		copytree based on https://stackoverflow.com/a/12514470/3092681
 # 			Copyright © 2012 atzz
@@ -21,14 +21,29 @@
 #  Copyright © 1995-2000 Corporation for National Research Initiatives . All rights reserved.
 #  Copyright © 1991-1995 Stichting Mathematisch Centrum . All rights reserved.
 #
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation; either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+#  MA 02110-1301, USA.
+#
 
 from domdf_python_tools.utils import *
 from domdf_python_tools import paths, terminal, utils, doctools
 
 __all__ = ["paths", "terminal", "utils", "dates"]
 
 __author__ = "Dominic Davis-Foster"
-__copyright__ = "2014-2019 Dominic Davis-Foster"
+__copyright__ = "2014-2020 Dominic Davis-Foster"
 
 __license__ = "LGPLv3+"
 __version__ = "0.2.1"

domdf_python_tools/paths.py

@@ -6,7 +6,7 @@
 Functions for paths and files
 """
 #
-#  Copyright © 2018-2019 Dominic Davis-Foster <[email protected]>
+#  Copyright © 2018-2020 Dominic Davis-Foster <[email protected]>
 #
 #  check_dependencies based on https://stackoverflow.com/a/29044693/3092681
 #  		Copyright © 2015 TehTechGuy
@@ -58,15 +58,26 @@ def copytree(src, dst, symlinks=False, ignore=None):
 	:type src: str
 	:param dst: Destination to copy file to
 	:type dst: str
-	:param symlinks: Whether to represent symbolic links in the source as symbolic links in the destination
-		If false or omitted, the contents and metadata of the linked files are copied to the new tree.
-		When symlinks is false, if the file pointed by the symlink doesn’t exist, an exception will be added in the list of errors raised in an Error exception at the end of the copy process. You can set the optional ignore_dangling_symlinks flag to true if you want to silence this exception. Notice that this option has no effect on platforms that don’t support os.symlink().
+	:param symlinks: Whether to represent symbolic links in the source as symbolic
+		links in the destination. If false or omitted, the contents and metadata
+		of the linked files are copied to the new tree. When symlinks is false,
+		if the file pointed by the symlink doesn't exist, an exception will be
+		added in the list of errors raised in an Error exception at the end of
+		the copy process. You can set the optional ignore_dangling_symlinks
+		flag to true if you want to silence this exception. Notice that this
+		option has no effect on platforms that don’t support os.symlink().
 	:type symlinks: bool
-	:param ignore: A callable that will receive as its arguments the source directory, and a list of its contents.
-		The ignore callable will be called once for each directory that is copied.
-		The callable must return a sequence of directory and file names relative to the current directory (i.e. a subset of the items in its second argument); these names will then be ignored in the copy process. ignore_patterns() can be used to create such a callable that ignores names based on glob-style patterns.
+	:param ignore: A callable that will receive as its arguments the source
+		directory, and a list of its contents. The ignore callable will be
+		called once for each directory that is copied. The callable must return
+		a sequence of directory and file names relative to the current
+		directory (i.e. a subset of the items in its second argument); these
+		names will then be ignored in the copy process. ignore_patterns() can
+		be used to create such a callable that ignores names based on
+		glob-style patterns.
 
 	:return:
+	:rtype:
 	"""
 
 	import shutil
@@ -119,7 +130,8 @@ def relpath(path, relative_to=None):
 	
 	:param path: Path to find the relative path for
 	:type path: str
-	:param relative_to: The directory to find the path relative to. Defaults to the current working directory (i.e. os.getcwd())
+	:param relative_to: The directory to find the path relative to.
+		Defaults to the current working directory (i.e. os.getcwd())
 	:type relative_to: str
 	
 	:return:
@@ -128,8 +140,10 @@ def relpath(path, relative_to=None):
 	if relative_to is None:
 		relative_to = os.getcwd()
 
-	#if os.path.normpath(os.path.abspath(path)).startswith(os.path.normpath(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))):
-	if os.path.normpath(os.path.abspath(path)).startswith(os.path.normpath(os.path.dirname(os.path.dirname(os.path.abspath(relative_to))))):
+	# if os.path.normpath(os.path.abspath(path)).startswith(
+	# 		os.path.normpath(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))):
+	if os.path.normpath(os.path.abspath(path)).startswith(
+			os.path.normpath(os.path.dirname(os.path.dirname(os.path.abspath(relative_to))))):
 		return os.path.relpath(os.path.abspath(path))
 	else:
 		return os.path.abspath(path)

domdf_python_tools/terminal.py

@@ -6,7 +6,7 @@
 Useful functions for terminal-based programs
 """
 #
-#  Copyright © 2014-2019 Dominic Davis-Foster <[email protected]>
+#  Copyright © 2014-2020 Dominic Davis-Foster <[email protected]>
 #
 #  get_terminal_size, _get_terminal_size_windows, _get_terminal_size_tput and _get_terminal_size_linux
 # 		from https://gist.github.com/jtriley/1108174
@@ -64,7 +64,6 @@ def br():
 	print("")
 
 
-
 def interrupt():
 	"""
 	Print what to do to abort the script; dynamic depending on OS
@@ -94,7 +93,9 @@ def overtype(*objects, sep=' ', end='', file=sys.stdout, flush=False):
 	:param file: An object with a ``write(string)`` method; default ``sys.stdout``
 	:param flush: If true, the stream is forcibly flushed.
 	:type flush: bool
+	
 	:return:
+	:rtype:
 	"""
 
 	object0 = f"\r{objects[0]}"
@@ -111,6 +112,7 @@ def get_terminal_size():
 	Originally retrieved from: http://stackoverflow.com/questions/566746/how-to-get-console-window-width-in-python
 	
 	:return: tuple_xy
+	:rtype:
 	"""
 
 	current_os = platform.system()
@@ -138,9 +140,11 @@ def _get_terminal_size_windows():
 		csbi = create_string_buffer(22)
 		res = windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
 		if res:
-			(buf_x, buf_y, cur_x, cur_y, wattr,
-			 left, top, right, bottom,
-			 maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
+			(
+					buf_x, buf_y, cur_x, cur_y, wattr,
+					left, top, right, bottom,
+					maxx, maxy,
+					) = struct.unpack("hhhhHhhhhhh", csbi.raw)
 			size_x = right - left + 1
 			size_y = bottom - top + 1
 			return size_x, size_y

domdf_python_tools/utils.py

@@ -6,7 +6,7 @@
 General Functions
 """
 #
-#  Copyright © 2018-2019 Dominic Davis-Foster <[email protected]>
+#  Copyright © 2018-2020 Dominic Davis-Foster <[email protected]>
 #
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU Lesser General Public License as published by
@@ -100,7 +100,7 @@ def check_dependencies(dependencies, prt=True):
 
 	missing_modules = []
 	for requirement in dependencies:
-		if not requirement in modules:
+		if requirement not in modules:
 			missing_modules.append(requirement)
 
 	if prt:

tests/requirements.txt

@@ -0,0 +1,4 @@
+pytest >= 5.1.1
+pytest-cov >= 2.8.1
+pytz >= 2019.1
+coverage>=5.1

tests/test_dates.py

@@ -42,7 +42,6 @@ def test_utc_offset():
 	# TODO: Finish
 
 
-
 def test_converting_timezone():
 	# No matter what timezone we convert to the timestamp should be the same
 	for tz in pytz.all_timezones:

tests/test_doctools.py

@@ -15,6 +15,7 @@
 
 # TODO: test sphinxification of docstrings
 
+
 class Cafe:
 	"""
 	Generic class for a Cafe
@@ -197,7 +198,8 @@ def test_decorators():
 
 	# Functions
 	assert undocumented_function.__doc__ == documented_function.__doc__
-	assert partially_documented_function.__doc__.startswith("\nThis function works like documented function except it returns the result telepathically.")
+	assert partially_documented_function.__doc__.startswith(
+			"\nThis function works like documented function except it returns the result telepathically.")
 	assert doctools.deindent_string(partially_documented_function.__doc__).endswith(
 			doctools.deindent_string(documented_function.__doc__))
 	# Deindented both strings to be sure of equivalence
@@ -234,5 +236,3 @@ def funC():
 
 	doctools.append_doctring_from_another(funB, funC)
 	assert funB.__doc__ == "Hello\nWorld"
-	
-	

tests/test_init.py

@@ -13,66 +13,46 @@
 
 import pytest
 
-from domdf_python_tools.utils import str2tuple, tuple2str, chunks, list2str, list2string, bdict
+from domdf_python_tools.utils import str2tuple, tuple2str, chunks, list2str, list2string, bdict, pyversion
 from domdf_python_tools import utils
 
 
+def test_pyversion():
+	assert isinstance(pyversion, int)
+
+
 def test_str2tuple():
 	assert isinstance(str2tuple("1,2,3"), tuple)  # tests without spaces
 	assert isinstance(str2tuple("1, 2, 3"), tuple)  # tests with spaces
 	assert isinstance(str2tuple("1; 2; 3", sep=";"), tuple)  # tests with semicolon
-	if str2tuple("1,2,3") == (1, 2, 3):
-		assert 1
-	else:
-		assert 0
+	assert str2tuple("1,2,3") == (1, 2, 3)
 
 
 def test_tuple2str():
 	assert isinstance(tuple2str(("1", "2", "3",)), str)
-	if tuple2str((1, 2, 3)) == "1,2,3":
-		assert 1
-	else:
-		assert 0
+	assert tuple2str((1, 2, 3)) == "1,2,3"
 
 	assert isinstance(tuple2str((1, 2, 3,), sep=";"), str)  # tests with semicolon
-	if tuple2str((1, 2, 3), sep=";") == "1;2;3":
-		assert 1
-	else:
-		assert 0
+	assert tuple2str((1, 2, 3), sep=";") == "1;2;3"
 
 
 def test_chunks():
 	assert isinstance(chunks(list(range(100)), 5), types.GeneratorType)
-	if list(chunks(list(range(100)), 5))[0] == [0, 1, 2, 3, 4]:
-		assert 1
-	else:
-		assert 0
+	assert list(chunks(list(range(100)), 5))[0] == [0, 1, 2, 3, 4]
 
 
 def test_list2str():
 	assert isinstance(list2str([1, 2, 3, ]), str)
-	if list2str([1, 2, 3]) == "1,2,3":
-		assert 1
-	else:
-		assert 0
+	assert list2str([1, 2, 3]) == "1,2,3"
 
 	assert isinstance(list2str([1, 2, 3], sep=";"), str)  # tests with semicolon
-	if list2str((1, 2, 3), sep=";") == "1;2;3":
-		assert 1
-	else:
-		assert 0
+	assert list2str((1, 2, 3), sep=";") == "1;2;3"
 
 	assert isinstance(list2string([1, 2, 3, ]), str)
-	if list2string([1, 2, 3]) == "1,2,3":
-		assert 1
-	else:
-		assert 0
+	assert list2string([1, 2, 3]) == "1,2,3"
 
 	assert isinstance(list2string([1, 2, 3], sep=";"), str)  # tests with semicolon
-	if list2string((1, 2, 3), sep=";") == "1;2;3":
-		assert 1
-	else:
-		assert 0
+	assert list2string((1, 2, 3), sep=";") == "1;2;3"
 
 
 def test_bdict():
@@ -110,13 +90,13 @@ def test_bdict_booleans():
 	new_dict = bdict(original_dict)
 
 	assert new_dict[True] == "True"
-	assert new_dict["True"] == True
+	assert new_dict["True"]
 
 	original_dict = {True: True, False: False, None: None}
 
 	new_dict = bdict(original_dict)
 
-	assert new_dict[True] is True
+	assert new_dict[True]
 
 
 def test_bdict_from_zip():
@@ -231,4 +211,3 @@ def test_permutations():
 
 	with pytest.raises(ValueError):
 		utils.permutations(data, 0)
-