Less is More...

Author: reactive-firewall

pythonrepo/__init__.py

@@ -18,7 +18,7 @@
 
 
 __module__ = """pythonrepo"""
-"""This is pythonrepo __module Template"""
+"""This is pythonrepo module Template."""
 
 
 __version__ = """1.1.4"""
@@ -40,4 +40,3 @@
 	baton.__cause__ = err
 	raise baton
 
-

pythonrepo/pythonrepo.py

@@ -19,6 +19,7 @@
 
 
 __module__ = """pythonrepo.pythonrepo"""
+"""This is pythonrepo component Template."""
 
 
 try:
@@ -132,5 +133,6 @@ def main(*argv):
 
 
 if __name__ in '__main__':
+	# deepsource overlooks the readability of "if main" type code here. (See PTC-W0048)
 	if (sys.argv is not None) and (len(sys.argv) >= 1):
 		main(sys.argv[1:])

tests/profiling.py

@@ -1,9 +1,9 @@
 #! /usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# Python Repo Template
+# Python Test Repo Template
 # ..................................
-# Copyright (c) 2017-2019, Kendrick Walls
+# Copyright (c) 2017-2022, Kendrick Walls
 # ..................................
 # Licensed under MIT (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@
 # limitations under the License.
 
 
-# Third-party Acknowlegement:
+# Third-party Acknowledgement:
 # ..........................................
 # Some code (namely: class timewith, @do_cprofile, @do_line_profile) was modified/derived from:
 # https://github.com/zapier/profiling-python-like-a-boss/tree/1ab93a1154
@@ -30,36 +30,55 @@
 
 
 try:
-	import os
 	import sys
+	if sys.__name__ is None:  # pragma: no branch
+		raise ImportError("[CWE-758] OMG! we could not import sys! ABORT. ABORT.")
+except Exception as err:  # pragma: no branch
+	raise ImportError(err)
+
+
+try:
+	if 'os' not in sys.modules:
+		import os
+	else:  # pragma: no branch
+		os = sys.modules["""os"""]
+except Exception:  # pragma: no branch
+	raise ImportError("[CWE-758] OS Failed to import.")
+
+
+try:
 	import time
-	import cProfile
-	for keyModule in [os, sys, time, cProfile]:
-		if keyModule.__name__ is None:
-			raise NotImplementedError(
-				str("OMG! We could not import the {}!").format(
-					str(keyModule)
-				)
-			)
+	if time.__name__ is None:  # pragma: no branch
+		raise NotImplementedError("[CWE-440] We could not import time. Are we in the speed-force!")
 except Exception as err:
 	raise ImportError(err)
+	exit(3)
+
+
+try:
+	import cProfile
+	if cProfile.__name__ is None:  # pragma: no branch
+		raise NotImplementedError("[CWE-440] We could not import cProfile. ABORT!")
+except Exception as err:  # pragma: no branch
+	raise ImportError(err)
+	exit(3)
 
 
 try:
 	try:
 		sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), str('..'))))
 		sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), str('.'))))
-	except Exception as ImportErr:
+	except Exception as ImportErr:  # pragma: no branch
 		print(str(''))
 		print(str(type(ImportErr)))
 		print(str(ImportErr))
 		print(str((ImportErr.args)))
 		print(str(''))
 		ImportErr = None
 		del ImportErr
-		raise ImportError(str("Profile module failed completely."))
-except Exception:
-	raise ImportError("Failed to import test profiling")
+		raise ImportError(str("[CWE-758] Profile module failed completely."))
+except Exception:  # pragma: no branch
+	raise ImportError("[CWE-440] Failed to import test profiling")
 
 
 class timewith():
@@ -86,15 +105,43 @@ def __enter__(self):
 
 	def __exit__(self, type, value, traceback):
 		self.checkpoint(str("finished"))
+		pass
 
 
 def do_time_profile(func, timer_name="time_profile"):
-	"""Runs a function with a timer"""
+	"""Run a function with a timer.
+
+	Time Testing:
+
+		First some test fixtures:
+
+		>>> import tests.context as context
+		>>> from context import profiling as profiling
+		>>>
+
+	Testcase 0: test the time_profile.
+
+		>>> def doWork():
+		...    \"""Does some work.\"""
+		...    for i in range(0, 42):
+		...        print(str("Do Task {}").format(int(i)))
+		>>>
+		>>> profiling.do_time_profile(
+		...    doWork,
+		...    timer_name=str("work time test")
+		... )() #doctest: -DONT_ACCEPT_BLANKLINE, +ELLIPSIS
+		work...Start Timer...
+		...Do Task...
+		work...Stop Timer...
+		work...took ... seconds
+		>>>
+
+	"""
 	import functools
 
 	@functools.wraps(func)
 	def timer_profile_func(*args, **kwargs):
-		"""Wraps a function in timewith()"""
+		"""Wraps a function in timewith() function."""
 		theOutput = None
 		with timewith(timer_name) as timer:
 			timer.checkpoint(str("Start Timer"))
@@ -106,7 +153,36 @@ def timer_profile_func(*args, **kwargs):
 
 
 def do_cprofile(func):
-	"""use built-in profiler to profile."""
+	"""Use built-in profiler to profile.
+
+	Time Testing:
+
+		First some test fixtures:
+
+		>>> import tests.context as context
+		>>> from context import profiling as profiling
+		>>>
+
+	Testcase 0: test the time_profile.
+
+		>>> def doWork():
+		...    \"""Does some work.\"""
+		...    for i in range(0, 42):
+		...        print(str("Do Task {}").format(int(i)))
+		>>>
+		>>> profiling.do_cprofile(
+		...    doWork
+		... )() #doctest: -DONT_ACCEPT_BLANKLINE, +ELLIPSIS
+		Do Task 0...Do Task 10...Do Task 20...Do Task 30...Do Task 40...
+		...function calls in ... seconds...Ordered by: standard name...
+		...ncalls  tottime  percall  cumtime  percall filename:lineno(function)...
+		...<...>:1(doWork)...{built-in method builtins.print}...
+		<BLANKLINE>
+		<BLANKLINE>
+		>>>
+
+
+	"""
 	def profiled_func(*args, **kwargs):
 		profile = cProfile.Profile()
 		try:
@@ -122,7 +198,7 @@ def profiled_func(*args, **kwargs):
 try:  # noqa
 	from line_profiler import LineProfiler
 
-	def do_profile(follow=None):
+	def do_profile(follow=None):  # pragma: no cover
 		if follow is None:
 			follow = []
 
@@ -140,9 +216,9 @@ def profiled_func(*args, **kwargs):
 			return profiled_func
 		return inner
 
-except ImportError:
+except ImportError:  # pragma: no cover
 	def do_profile(follow=None):
-		"Helpful if you accidentally leave in production!"
+		"""Helpful if you accidentally leave in production!"""
 		if follow is None:
 			follow = []
 
@@ -153,16 +229,15 @@ def nothing(*args, **kwargs):
 		return inner
 
 
-def main(argv=None):
-	"""The Main Event makes no sense to remediation."""
+def main(argv=None):  # pragma: no cover
+	"""The Main Event makes no sense to profiling."""
 	raise NotImplementedError("CRITICAL - test profiling main() not implemented. yet?")
 
 
-if __name__ in '__main__':
+if __name__ in '__main__':  # pragma: no cover
 	exitcode = 3
 	try:
 		exitcode = main(sys.argv[1:])
 	finally:
 		exit(exitcode)
 
-

tests/test_usage.py

@@ -52,7 +52,7 @@ def getPythonCommand():
 
 
 def buildPythonCommand(args=None):
-	"""Function for building backend subprocess command line"""
+	"""Function for building backend subprocess command line."""
 	theArgs = args
 	# you need to change this to the name of your project
 	__project__ = str("pythonrepo")
@@ -80,7 +80,7 @@ def buildPythonCommand(args=None):
 
 
 def checkPythonCommand(args=None, stderr=None):
-	"""Function for backend subprocess check_output command like testing with coverage support"""
+	"""Function for backend subprocess check_output command like testing with coverage support."""
 	theOutput = None
 	try:
 		taintArgs = buildPythonCommand(args)
@@ -163,11 +163,11 @@ class BasicUsageTestSuite(unittest.TestCase):
 	"""Basic functional test cases."""
 
 	def test_absolute_truth_and_meaning(self):
-		"""Insanity Test. if ( is true ) """
+		"""Insanity Test. if ( is true ) usage."""
 		assert True
 
 	def test_syntax(self):
-		"""Test case importing code. if ( import is not None ) """
+		"""Test case importing code. if ( import is not None ) usage."""
 		theResult = False
 		try:
 			from .context import pythonrepo
@@ -181,7 +181,7 @@ def test_syntax(self):
 		assert theResult
 
 	def test_template_case(self):
-		"""Test case template for: python -m pythonrepo.* --version """
+		"""Test case template for: python -m pythonrepo.* --version usage."""
 		theResult = False
 		thepython = getPythonCommand()
 		if (thepython is not None):
@@ -220,7 +220,7 @@ def test_template_case(self):
 		assert theResult
 
 	def test_profile_template_case(self):
-		"""Test case template for profiling"""
+		"""Test case template for profiling."""
 		theResult = False
 		thepython = getPythonCommand()
 		if (thepython is not None):
@@ -259,7 +259,7 @@ def test_profile_template_case(self):
 
 	@unittest.expectedFailure
 	def test_fail_template_case(self):
-		"""Test case template for profiling"""
+		"""Test case template for profiling."""
 		theResult = False
 		thepython = getPythonCommand()
 		if (thepython is not None):
@@ -298,7 +298,7 @@ def test_fail_template_case(self):
 
 	@unittest.expectedFailure
 	def test_bad_template_case(self):
-		"""Test case template for profiling"""
+		"""Test case template for profiling."""
 		theResult = False
 		thepython = getPythonCommand()
 		if (thepython is not None):