Updated docstrings and some copyrights. Reformatting. Removed entry function because it is now redundant in production code.

Author: domdfcoding

domdf_python_tools/__init__.py

@@ -14,7 +14,13 @@
 # 			Copyright © 2012 atzz
 # 			Licensed under CC-BY-SA
 #
-
+#  Parts of the docstrings based on the Python 3.8.2 Documentation
+#  Licensed under the Python Software Foundation License Version 2.
+#  Copyright © 2001-2020 Python Software Foundation. All rights reserved.
+#  Copyright © 2000 BeOpen.com . All rights reserved.
+#  Copyright © 1995-2000 Corporation for National Research Initiatives . All rights reserved.
+#  Copyright © 1991-1995 Stichting Mathematisch Centrum . All rights reserved.
+#
 
 from domdf_python_tools.utils import *
 from domdf_python_tools import paths, terminal, utils, doctools

domdf_python_tools/dates.py

@@ -42,7 +42,7 @@ def current_tzinfo():
 		"""
 		Returns a tzinfo object for the current timezone
 		
-		:rtype: :class:`~python:datetime.datetime.tzinfo`
+		:rtype: :class:`~python:datetime.tzinfo`
 		"""
 
 		return datetime.datetime.now().astimezone().tzinfo
@@ -56,7 +56,7 @@ def datetime_to_utc_timestamp(datetime, current_tzinfo=None):
 		:type datetime: :class:`datetime.datetime`
 		:param current_tzinfo: A tzinfo object representing the current timezone.
 			If None it will be inferred.
-		:type current_tzinfo: :class:`~python:datetime.datetime.tzinfo`
+		:type current_tzinfo: :class:`~python:datetime.tzinfo`
 		
 		:return: Timestamp in UTC timezone
 		:rtype: float
@@ -72,15 +72,15 @@ def utc_timestamp_to_datetime(utc_timestamp, output_tz=None):
 		If ``output_tz`` is None the timestamp is converted to the platform’s local date and time,
 		and the local timezone is inferred and set for the object.
 	
-		If ``output_tz`` is not None, it must be an instance of a :class:`~python:datetime.datetime.tzinfo` subclass,
-		and the timestamp is converted to tz’s time zone.
+		If ``output_tz`` is not None, it must be an instance of a :class:`~python:datetime.tzinfo` subclass,
+		and the timestamp is converted to ``output_tz``’s time zone.
 	
 		
 		:param utc_timestamp: The timestamp to convert to a datetime object
 		:type utc_timestamp: float, int
 		:param output_tz: The timezone to output the datetime object for.
 			If None it will be inferred.
-		:type output_tz: :class:`~python:datetime.datetime.tzinfo`
+		:type output_tz: :class:`~python:datetime.tzinfo`
 		
 		:return: The timestamp as a datetime object.
 		:rtype: :class:`datetime.datetime`

domdf_python_tools/doctools.py

@@ -110,8 +110,8 @@ def make_sphinx_links(input_string, builtins_list=None):
 	
 	
 	Make sure to have `'python': ('https://docs.python.org/3/', None),` in the
-	 `intersphinx_mapping` dict of your conf.py for sphinx.
-	 
+	`intersphinx_mapping` dict of your conf.py for sphinx.
+	
 	:param input_string: The string to process
 	:type input_string: str
 	:param builtins_list: A list of builtins to make links for
@@ -139,7 +139,7 @@ def sphinxify_docstring():
 	i.e. \`\`str\`\` becomes \:class\:\`~python:str\`
 	
 	Make sure to have `'python': ('https://docs.python.org/3/', None),` in the
-	 `intersphinx_mapping` dict of your conf.py for sphinx.
+	`intersphinx_mapping` dict of your conf.py for sphinx.
 	"""
 
 	def wrapper(target):

domdf_python_tools/paths.py

@@ -20,6 +20,13 @@
 # 		Copytight © 2008 Ned Batchelder
 # 		Licensed under CC-BY-SA
 #
+#  Parts of the docstrings based on the Python 3.8.2 Documentation
+#  Licensed under the Python Software Foundation License Version 2.
+#  Copyright © 2001-2020 Python Software Foundation. All rights reserved.
+#  Copyright © 2000 BeOpen.com . All rights reserved.
+#  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

domdf_python_tools/terminal.py

@@ -12,6 +12,13 @@
 # 		from https://gist.github.com/jtriley/1108174
 #  		Copyright © 2011 jtriley
 #
+#  Parts of the docstrings based on the Python 3.8.2 Documentation
+#  Licensed under the Python Software Foundation License Version 2.
+#  Copyright © 2001-2020 Python Software Foundation. All rights reserved.
+#  Copyright © 2000 BeOpen.com . All rights reserved.
+#  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
@@ -27,25 +34,21 @@
 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 #  MA 02110-1301, USA.
 #
-#
 
 # stdlib
 import os
-import sys
+import platform
 import shlex
 import struct
-import platform
 import subprocess
-
-# this package
-from domdf_python_tools import pyversion
+import sys
 
 
 def clear():
 	"""
 	Clear the display
 	
-	works for Windows and UNIX, but does not clear Python Shell
+	works for Windows and UNIX, but does not clear Python Interpreter
 	
 	:return:
 	"""
@@ -61,32 +64,14 @@ def br():
 	print("")
 
 
-def entry(text_to_print):
-	"""
-	Version-agnostic input function
-	
-	# TODO: Deprecation warning
-	
-	:param text_to_print: Text to print before the input field
-	:type text_to_print: str
-	
-	:return: Text entered
-	:rtype: str
-	"""
-	
-	if pyversion == 3:
-		return input(text_to_print)
-	elif pyversion == 2:
-		return raw_input(text_to_print)
-
 
 def interrupt():
 	"""
 	Print what to do to abort the script; dynamic depending on OS
 	Useful when you have a long-running script that you might want t interrupt part way through
 	"""
 
-	print('(Press Ctrl-%s to quit at any time.)' % 'C' if os.name == 'nt' else 'D')
+	print(f"(Press Ctrl-{'C' if os.name == 'nt' else 'D'} to quit at any time.)")
 
 
 def overtype(*objects, sep=' ', end='', file=sys.stdout, flush=False):
@@ -97,11 +82,9 @@ def overtype(*objects, sep=' ', end='', file=sys.stdout, flush=False):
 	All non-keyword arguments are converted to strings like ``str()`` does and written to the stream,
 	separated by `sep` and followed by `end`.
 
-	If no objects are given, ``overwrite()` will just write "\r".
-
-	Based on the Python print() docs: https://docs.python.org/3/library/functions.html#print
+	If no objects are given, ``overtype()`` will just write "\r".
 
-	# This does not currently work in the PyCharm console, at least on Windows
+	TODO: This does not currently work in the PyCharm console, at least on Windows
 
 	:param objects:
 	:param sep: String to separate the objects with, by default " "
@@ -155,12 +138,12 @@ def _get_terminal_size_windows():
 		csbi = create_string_buffer(22)
 		res = windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
 		if res:
-			(bufx, bufy, curx, cury, wattr,
+			(buf_x, buf_y, cur_x, cur_y, wattr,
 			 left, top, right, bottom,
 			 maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
-			sizex = right - left + 1
-			sizey = bottom - top + 1
-			return sizex, sizey
+			size_x = right - left + 1
+			size_y = bottom - top + 1
+			return size_x, size_y
 	except:
 		pass
 
@@ -171,7 +154,7 @@ def _get_terminal_size_tput():
 	try:
 		cols = int(subprocess.check_call(shlex.split('tput cols')))
 		rows = int(subprocess.check_call(shlex.split('tput lines')))
-		return (cols, rows)
+		return cols, rows
 	except:
 		pass
 
@@ -181,8 +164,7 @@ def ioctl_GWINSZ(fd):
 		try:
 			import fcntl
 			import termios
-			cr = struct.unpack('hh',
-							   fcntl.ioctl(fd, termios.TIOCGWINSZ, '1234'))
+			cr = struct.unpack('hh', fcntl.ioctl(fd, termios.TIOCGWINSZ, '1234'))
 			return cr
 		except:
 			pass
@@ -203,5 +185,5 @@ def ioctl_GWINSZ(fd):
 
 
 if __name__ == "__main__":
-	sizex, sizey = get_terminal_size()
-	print('width =', sizex, 'height =', sizey)
+	size_x, size_y = get_terminal_size()
+	print('width =', size_x, 'height =', size_y)

domdf_python_tools/utils.py

@@ -107,9 +107,9 @@ def check_dependencies(dependencies, prt=True):
 		if len(missing_modules) == 0:
 			print("All modules installed")
 		else:
-			print("""\rThe following modules are missing.
-	Please check the documentation.""")
+			print("The following modules are missing.")
 			print(missing_modules)
+			print("Please check the documentation.")
 		print("")
 
 	else:
@@ -148,7 +148,7 @@ def list2str(the_list, sep=","):
 	return sep.join([str(x) for x in the_list])
 
 
-def splitLen(string,n):
+def splitLen(string, n):
 	"""
 	Split a string every x characters
 	
@@ -158,7 +158,7 @@ def splitLen(string,n):
 	:return:
 	"""
 
-	return [string[i:i+n] for i in range(0,len(string),n)]
+	return [string[i:i + n] for i in range(0, len(string), n)]
 
 
 def permutations(data, n=2):
@@ -216,7 +216,7 @@ def __init__(self, *args, **kwargs):
 		if len(args) == 0:
 			for key, value in kwargs.items():
 				self.__setitem__(key, value)
-
+	
 	def __setitem__(self, key, val):
 		if key in self or val in self:
 			if key in self and self[key] != val:
@@ -259,7 +259,7 @@ def __getitem__(self, key):
 				key = "_False"
 
 		val = dict.__getitem__(self, key)
-
+		
 		if val == "_None":
 			return None
 		elif val == "_True":