Removed unnecessary whitespace

Author: domdfcoding

domdf_python_tools/bases.py

@@ -25,7 +25,6 @@
 #
 
 
-
 # stdlib
 from abc import ABC, abstractmethod
 from collections import UserList
@@ -39,38 +38,38 @@ class Dictable(ABC):
 	"""
 	The basic structure of a class than can be converted into a dictionary
 	"""
-	
+
 	@abstractmethod
 	def __init__(self, *args, **kwargs):
 		pass
-	
+
 	def __str__(self):
 		return self.__repr__()
-	
+
 	def __iter__(self):
 		for key, value in self.__dict__().items():
 			yield key, value
-	
+
 	def __getstate__(self):
 		return self.__dict__()
-	
+
 	def __setstate__(self, state):
 		self.__init__(**state)
-	
+
 	def __copy__(self):
 		return self.__class__(**self.__dict__())
-	
+
 	def __deepcopy__(self, memodict={}):
 		return self.__copy__()
-	
+
 	@abstractmethod
 	def __dict__(self):
 		return dict()
-	
+
 	def __eq__(self, other):
 		if isinstance(other, self.__class__):
 			return pydash.predicates.is_match(other.__dict__(), self.__dict__())
-		
+
 		return NotImplemented
 
 
@@ -83,18 +82,18 @@ def namedlist(name="NamedList"):
 	:return:
 	:rtype:
 	"""
-	
+
 	class NamedList(UserList):
 		"""
 		A list with a name
 		"""
-		
+
 		def __repr__(self):
 			return f"{super().__repr__()}"
-		
+
 		def __str__(self):
 			return f"{self.__class__.__name__}{pformat(list(self))}"
-	
+
 	NamedList.__name__ = name
-	
+
 	return NamedList

domdf_python_tools/dates.py

@@ -38,30 +38,28 @@
 # 3rd party
 try:
 	import pytz
-	
-	
+
 	def get_utc_offset(tz, date=None):
 		"""
 		Returns the offset between UTC and the requested timezone on the given date.
 		If ``date`` is ``None`` then the current date is used.
-		
+
 		:param tz: :class:`pytz.timezone` or a string representing the timezone
 		:type tz:
 		:param date:
 		:type date: :class:`python:datetime.datetime` or None, optional
 		:return:
 		:rtype: :class:`python:datetime.timedelta`
 		"""
-		
+
 		if date is None:
 			date = datetime.datetime.utcnow()
-		
+
 		if isinstance(tz, str):
 			tz = get_timezone(tz, date)
-		
+
 		return date.replace(tzinfo=pytz.utc).astimezone(tz).utcoffset()
-	
-	
+
 	def get_timezone(tz, date=None):
 		"""
 		Returns a localized :class:`pytz.timezone` object for the given date.
@@ -74,24 +72,23 @@ def get_timezone(tz, date=None):
 		:return:
 		:rtype: :class:`python:datetime.timedelta`
 		"""
-		
+
 		if date is None:
 			date = datetime.datetime.utcnow()
-			
+
 		d = date.replace(tzinfo=None)
 
 		return pytz.timezone(tz).localize(d).tzinfo
-	
-	
+
 	def current_tzinfo():
 		"""
 		Returns a tzinfo object for the current timezone
-		
+
 		:rtype: :class:`python:datetime.tzinfo`
 		"""
-		
+
 		return datetime.datetime.now().astimezone().tzinfo
-	
+
 	#
 	# def datetime_to_utc_timestamp(datetime, current_tzinfo=None):
 	# 	"""
@@ -109,55 +106,53 @@ def current_tzinfo():
 	#
 	# 	return datetime.astimezone(current_tzinfo).timestamp()
 	#
-		
+
 	def set_timezone(obj, tzinfo):
 		"""
 		Sets the timezone / tzinfo of the given :class:`datetime.datetime` object.
 		This will not convert the time (i.e. the hours will stay the same).
 		Use :meth:`python:datetime.datetime.astimezone` to accomplish that.
-		
+
 		:param obj:
 		:type obj:
-		:param tzinfo: 
-		:type tzinfo: 
-		
+		:param tzinfo:
+		:type tzinfo:
+
 		:return:
-		:rtype: 
+		:rtype:
 		"""
-		
+
 		return obj.replace(tzinfo=tzinfo)
-		
-	
+
 	def utc_timestamp_to_datetime(utc_timestamp, output_tz=None):
 		"""
 		Convert UTC timestamp (seconds from UNIX epoch) to a :class:`datetime.datetime` object
-		
+
 		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.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.tzinfo`
-		
+
 		:return: The timestamp as a datetime object.
 		:rtype: :class:`datetime.datetime`
-		
+
 		:raises: :class:`~python:OverflowError` if the timestamp is out of the range
 			of values supported by the platform C localtime() or gmtime() functions,
 			and OSError on localtime() or gmtime() failure. It’s common for this to
 			be restricted to years in 1970 through 2038.
 		"""
-		
+
 		new_datetime = datetime.datetime.fromtimestamp(utc_timestamp, output_tz)
 		return new_datetime.astimezone(output_tz)
-	
-	
+
 	# List of months and their 3-character shortcodes.
 	months = OrderedDict(
 			Jan="January",
@@ -173,8 +168,7 @@ def utc_timestamp_to_datetime(utc_timestamp, output_tz=None):
 			Nov="November",
 			Dec="December",
 			)
-	
-	
+
 	def parse_month(month):
 		"""
 		Converts an integer or shorthand month into the full month name
@@ -185,22 +179,21 @@ def parse_month(month):
 		:return: The full name of the month
 		:rtype: str
 		"""
-		
+
 		try:
 			month = int(month)
 		except ValueError:
 			try:
 				return months[month.capitalize()[:3]]
 			except KeyError:
 				raise ValueError("Unrecognised month value")
-		
+
 		# Only get here if first try succeeded
 		if 0 < month <= 12:
 			return list(months.values())[month - 1]
 		else:
 			raise ValueError("Unrecognised month value")
-	
-	
+
 	def get_month_number(month):
 		"""
 		Returns the number of the given month. If ``month`` is already a
@@ -212,7 +205,7 @@ def get_month_number(month):
 		:return: The number of the month
 		:rtype:
 		"""
-		
+
 		if isinstance(month, int):
 			if 0 < month <= 12:
 				return month
@@ -221,8 +214,7 @@ def get_month_number(month):
 		else:
 			month = parse_month(month)
 			return list(months.values()).index(month) + 1
-	
-	
+
 	def check_date(month, day, leap_year=True):
 		"""
 		Returns ``True`` if the day number is valid for the given month.
@@ -239,12 +231,12 @@ def check_date(month, day, leap_year=True):
 		:return: ``True`` if the date is valid
 		:rtype: bool
 		"""
-		
+
 		# Ensure day is an integer
 		day = int(day)
 		month = get_month_number(month)
 		year = 2020 if leap_year else 2019
-		
+
 		try:
 			datetime.date(year, month, day)
 			return True

domdf_python_tools/doctools.py

@@ -40,7 +40,7 @@ def deindent_string(string):
 	:return: The string without indentation
 	:rtype: str
 	"""
-	
+
 	split_string = string.split("\n")
 	deindented_string = [line.lstrip("\t ") for line in split_string]
 	return "\n".join(deindented_string)
@@ -58,7 +58,7 @@ def document_object_from_another(target, original):
 	:param original: The object to copy the docstring from
 	:type original: any
 	"""
-	
+
 	target.__doc__ = original.__doc__
 
 
@@ -77,10 +77,10 @@ def append_doctring_from_another(target, original):
 	:param original: The object to copy the docstring from
 	:type original: any
 	"""
-	
+
 	deindented_target_doc = deindent_string(target.__doc__)
 	deindented_original_doc = deindent_string(original.__doc__)
-	
+
 	target.__doc__ = deindented_target_doc + "\n" + deindented_original_doc
 
 
@@ -102,15 +102,15 @@ def make_sphinx_links(input_string, builtins_list=None):
 	:return: processed string with links
 	:rtype: str
 	"""
-	
+
 	if builtins_list is None:
 		builtins_list = dir(builtins)
-	
+
 	working_string = f"{input_string}"
-	
+
 	for builtin in {x for x in builtins_list if not x.startswith("__") and x != "None"}:
 		working_string = working_string.replace(f"``{builtin}``", f":class:`~python:{builtin}`")
-	
+
 	return working_string
 
 
@@ -121,11 +121,11 @@ def is_documented_by(original):
 
 	This may be useful for subclasses or wrappers that use the same arguments.
 	"""
-	
+
 	def wrapper(target):
 		document_object_from_another(target, original)
 		return target
-	
+
 	return wrapper
 
 
@@ -139,11 +139,11 @@ def append_docstring_from(original):
 	ensure consistent indentation between the two docstrings.
 	Bear this in mind if additional indentation is used in the docstring.
 	"""
-	
+
 	def wrapper(target):
 		append_doctring_from_another(target, original)
 		return target
-	
+
 	return wrapper
 
 
@@ -152,13 +152,13 @@ def sphinxify_docstring():
 	Make proper sphinx links out of double-backticked strings in 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.
 	"""
-	
+
 	def wrapper(target):
 		target.__doc__ = make_sphinx_links(target.__doc__)
 		return target
-	
+
 	return wrapper