16954025989

Committed 14 Aug 2025 02:00AM UTC coverage: 97.128%. Remained the same

Build # 16954025989

Build Type

push

github

Committed by

reactive-firewall

Commit Message

[HOTFIX] Fix for CI-CD regression

Changes in file .github/workflows/CI-CHGLOG.yml:
 * hotfix for regression of download-artifacts action logic after version bump

Run Details

127 of 133 branches covered (95.49%)

Branch coverage included in aggregate %.

2173 of 2235 relevant lines covered (97.23%)

6.23 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/tests/profiling.py

#! /usr/bin/env python
# -*- coding: utf-8 -*-

# Python Test Repo Template
# ..................................
# Copyright (c) 2017-2025, Mr. Walls
# ..................................
# Licensed under MIT (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# ..........................................
# https://github.com/reactive-firewall/python-repo/blob/HEAD/LICENSE.md
# ..........................................
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# 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
# Copyright (c) 2013, Zapier Inc. All rights reserved.
# which was under BSD-3 Clause license.
# see https://github.com/zapier/profiling-python-like-a-boss/blob/1ab93a1154/LICENSE.md for details
# ..........................................
# NO ASSOCIATION

__module__ = "tests.profiling"
"""This is pythonrepo testing module Template."""

try:
        import sys
        if not hasattr(sys, 'modules') or not sys.modules:  # pragma: no branch
                raise ModuleNotFoundError(
                        "[CWE-440] OMG! sys.modules is not available or empty.",
                ) from None
except ImportError as _cause:
        raise ImportError("[CWE-440] Unable to import sys module.") from _cause

try:
        if 'os' not in sys.modules:
                import os
        else:  # pragma: no branch
                os = sys.modules["os"]
except Exception as _cause:  # pragma: no branch
        baton = ModuleNotFoundError(_cause, str("[CWE-758] Test module failed completely."))
        baton.module = __module__
        baton.path = __file__
        baton.__cause__ = _cause
        raise baton from _cause

try:
        if 'functools' not in sys.modules:
                import functools
        else:  # pragma: no branch
                functools = sys.modules["functools"]
except Exception as _cause:  # pragma: no branch
        baton = ModuleNotFoundError(_cause, str("[CWE-758] Test module failed completely."))
        baton.module = __module__
        baton.path = __file__
        baton.__cause__ = _cause
        raise baton from _cause

try:
        import time
        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 _cause:  # pragma: no branch
        baton = ImportError(_cause, str("[CWE-758] Test module failed completely."))
        baton.module = __module__
        baton.path = __file__
        baton.__cause__ = _cause
        raise baton from _cause

try:
        if 'cProfile' not in sys.modules:
                import cProfile
        else:  # pragma: no branch
                cProfile = sys.modules["cProfile"]
except Exception as _cause:  # pragma: no branch
        baton = ModuleNotFoundError(_cause, str("[CWE-758] Test module failed completely."))
        baton.module = __module__
        baton.path = __file__
        baton.__cause__ = _cause
        raise baton from _cause

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 _root_cause:  # pragma: no branch
                raise ImportError(
                        _root_cause, str("[CWE-758] Profile module failed completely."),
                ) from _root_cause
except Exception as _cause:  # pragma: no branch
        baton = ImportError(_cause, str("[CWE-758] Test module failed completely."))
        baton.module = __module__
        baton.path = __file__
        baton.__cause__ = _cause
        raise baton from _cause


class timewith():
        """Basic timer for do_time_profile."""

        def __init__(self, name=""):
                self.name = name
                self.start = time.time()

        @property
        def elapsed(self):
                return time.time() - self.start

        def checkpoint(self, name=""):
                print(
                        str(f"{self.name} {name} took {self.elapsed} seconds").strip()
                )

        def __enter__(self):
                return self

        def __exit__(self, type, value, traceback):  # skipcq: PYL-W0622
                self.checkpoint(str("finished"))


def do_time_profile(func, timer_name="time_profile"):
        """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
                >>>

        """
        @functools.wraps(func)
        def timer_profile_func(*args, **kwargs):
                """Wraps a function in timewith() function."""
                theOutput = None
                with timewith(timer_name) as timer:
                        timer.checkpoint(str("Start Timer"))
                        theOutput = func(*args, **kwargs)
                        timer.checkpoint(str("Stop Timer"))
                return theOutput
        return timer_profile_func


def do_cprofile(func):
        """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>
                >>>

        """
        @functools.wraps(func)
        def profiled_func(*args, **kwargs):
                """Wraps a function in profile.enable/disable() functions."""
                profile = cProfile.Profile()
                try:
                        profile.enable()
                        result = func(*args, **kwargs)
                        profile.disable()
                        return result
                finally:
                        profile.print_stats()
        return profiled_func


try:  # noqa
        from line_profiler import LineProfiler

        def do_profile(follow=None):  # pragma: no cover
                if follow is None:
                        follow = []

                def inner(func):
                        def profiled_func(*args, **kwargs):
                                try:
                                        profiler = LineProfiler()
                                        profiler.add_function(func)
                                        for f in follow:
                                                profiler.add_function(f)
                                        profiler.enable_by_count()
                                        return func(*args, **kwargs)
                                finally:
                                        profiler.print_stats()
                        return profiled_func
                return inner

except ImportError:  # pragma: no cover
        def do_profile(follow=None):
                "Helpful if you accidentally leave in production!"
                if follow is None:
                        follow = []

                def inner(func):
                        def nothing(*args, **kwargs):
                                return func(*args, **kwargs)
                        return nothing
                return inner


def main(*argv):  # pragma: no cover
        """The Main Event makes no sense to profiling."""
        raise NotImplementedError("CRITICAL - test profiling main() not implemented. yet?") from None


if __name__ in '__main__':  # pragma: no cover
        exitcode = 2
        try:
                exitcode = main(sys.argv[1:])
        finally:
                exit(exitcode)  # skipcq: PYL-R1722 - intentionally allow overwriteing exit for testing

1	#! /usr/bin/env python
2	# -- coding: utf-8 --
3
4	# Python Test Repo Template
5	# ..................................
6	# Copyright (c) 2017-2025, Mr. Walls
7	# ..................................
8	# Licensed under MIT (the "License");
9	# you may not use this file except in compliance with the License.
10	# You may obtain a copy of the License at
11	# ..........................................
12	# https://github.com/reactive-firewall/python-repo/blob/HEAD/LICENSE.md
13	# ..........................................
14	# Unless required by applicable law or agreed to in writing, software
15	# distributed under the License is distributed on an "AS IS" BASIS,
16	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17	# See the License for the specific language governing permissions and
18	# limitations under the License.
19
20	# Third-party Acknowledgement:
21	# ..........................................
22	# Some code (namely: class timewith, @do_cprofile, @do_line_profile) was modified/derived from:
23	# https://github.com/zapier/profiling-python-like-a-boss/tree/1ab93a1154
24	# Copyright (c) 2013, Zapier Inc. All rights reserved.
25	# which was under BSD-3 Clause license.
26	# see https://github.com/zapier/profiling-python-like-a-boss/blob/1ab93a1154/LICENSE.md for details
27	# ..........................................
28	# NO ASSOCIATION
29
30	__module__ = "tests.profiling"	4✔
31	"""This is pythonrepo testing module Template."""	4✔
32
33	try:	4✔
34	import sys	4✔
35	if not hasattr(sys, 'modules') or not sys.modules: # pragma: no branch
36	raise ModuleNotFoundError(
37	"[CWE-440] OMG! sys.modules is not available or empty.",
38	) from None
39	except ImportError as _cause:
40	raise ImportError("[CWE-440] Unable to import sys module.") from _cause
41
42	try:	4✔
43	if 'os' not in sys.modules:
44	import os
45	else: # pragma: no branch
46	os = sys.modules["os"]
47	except Exception as _cause: # pragma: no branch
48	baton = ModuleNotFoundError(_cause, str("[CWE-758] Test module failed completely."))
49	baton.module = __module__
50	baton.path = __file__
51	baton.__cause__ = _cause
52	raise baton from _cause
53
54	try:	4✔
55	if 'functools' not in sys.modules:
56	import functools
57	else: # pragma: no branch
58	functools = sys.modules["functools"]
59	except Exception as _cause: # pragma: no branch
60	baton = ModuleNotFoundError(_cause, str("[CWE-758] Test module failed completely."))
61	baton.module = __module__
62	baton.path = __file__
63	baton.__cause__ = _cause
64	raise baton from _cause
65
66	try:	4✔
67	import time	4✔
68	if time.__name__ is None: # pragma: no branch	4✔
69	raise NotImplementedError("[CWE-440] We could not import time. Are we in the speed-force!")
70	except Exception as _cause: # pragma: no branch
71	baton = ImportError(_cause, str("[CWE-758] Test module failed completely."))
72	baton.module = __module__
73	baton.path = __file__
74	baton.__cause__ = _cause
75	raise baton from _cause
76
77	try:	4✔
78	if 'cProfile' not in sys.modules:
79	import cProfile
80	else: # pragma: no branch
81	cProfile = sys.modules["cProfile"]
82	except Exception as _cause: # pragma: no branch
83	baton = ModuleNotFoundError(_cause, str("[CWE-758] Test module failed completely."))
84	baton.module = __module__
85	baton.path = __file__
86	baton.__cause__ = _cause
87	raise baton from _cause
88
89	try:	4✔
90	try:	4✔
91	sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), str('..'))))	4✔
92	sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), str('.'))))	4✔
93	except Exception as _root_cause: # pragma: no branch
94	raise ImportError(
95	_root_cause, str("[CWE-758] Profile module failed completely."),
96	) from _root_cause
97	except Exception as _cause: # pragma: no branch
98	baton = ImportError(_cause, str("[CWE-758] Test module failed completely."))
99	baton.module = __module__
100	baton.path = __file__
101	baton.__cause__ = _cause
102	raise baton from _cause
103
104
105	class timewith():	4✔
106	"""Basic timer for do_time_profile."""
107
108	def __init__(self, name=""):	4✔
109	self.name = name	4✔
110	self.start = time.time()	4✔
111
112	@property	4✔
113	def elapsed(self):	4✔
114	return time.time() - self.start	4✔
115
116	def checkpoint(self, name=""):	4✔
117	print(	4✔
118	str(f"{self.name} {name} took {self.elapsed} seconds").strip()
119	)
120
121	def __enter__(self):	4✔
122	return self	4✔
123
124	def __exit__(self, type, value, traceback): # skipcq: PYL-W0622
125	self.checkpoint(str("finished"))
126
127
128	def do_time_profile(func, timer_name="time_profile"):	4✔
129	"""Run a function with a timer.
130
131	Time Testing:
132
133	First some test fixtures:
134
135	>>> import tests.context as context
136	>>> from context import profiling as profiling
137	>>>
138
139	Testcase 0: test the time_profile.
140
141	>>> def doWork():
142	... \"""Does some work.\"""
143	... for i in range(0, 42):
144	... print(str("Do Task {}").format(int(i)))
145	>>>
146	>>> profiling.do_time_profile(
147	... doWork,
148	... timer_name=str("work time test")
149	... )() #doctest: -DONT_ACCEPT_BLANKLINE, +ELLIPSIS
150	work...Start Timer...
151	...Do Task...
152	work...Stop Timer...
153	work...took ... seconds
154	>>>
155
156	"""
157	@functools.wraps(func)	4✔
158	def timer_profile_func(args, *kwargs):	4✔
159	"""Wraps a function in timewith() function."""
160	theOutput = None	4✔
161	with timewith(timer_name) as timer:	4✔
162	timer.checkpoint(str("Start Timer"))	4✔
163	theOutput = func(args, *kwargs)	4✔
164	timer.checkpoint(str("Stop Timer"))	4✔
165	return theOutput	4✔
166	return timer_profile_func	4✔
167
168
169	def do_cprofile(func):	4✔
170	"""Use built-in profiler to profile.
171
172	Time Testing:
173
174	First some test fixtures:
175
176	>>> import tests.context as context
177	>>> from context import profiling as profiling
178	>>>
179
180	Testcase 0: test the time_profile.
181
182	>>> def doWork():
183	... \"""Does some work.\"""
184	... for i in range(0, 42):
185	... print(str("Do Task {}").format(int(i)))
186	>>>
187	>>> profiling.do_cprofile(
188	... doWork
189	... )() #doctest: -DONT_ACCEPT_BLANKLINE, +ELLIPSIS
190	Do Task 0...Do Task 10...Do Task 20...Do Task 30...Do Task 40...
191	...function calls in ... seconds...Ordered by: standard name...
192	...ncalls tottime percall cumtime percall filename:lineno(function)...
193	...<...>:1(doWork)...{built-in method builtins.print}...
194	<BLANKLINE>
195	<BLANKLINE>
196	>>>
197
198	"""
199	@functools.wraps(func)	4✔
200	def profiled_func(args, *kwargs):	4✔
201	"""Wraps a function in profile.enable/disable() functions."""
202	profile = cProfile.Profile()	4✔
203	try:	4✔
204	profile.enable()	4✔
205	result = func(args, *kwargs)	4✔
206	profile.disable()	4✔
207	return result	4✔
208	finally:
209	profile.print_stats()	4✔
210	return profiled_func	4✔
211
212
213	try: # noqa	4✔
214	from line_profiler import LineProfiler	4✔
215
216	def do_profile(follow=None): # pragma: no cover
217	if follow is None:
218	follow = []
219
220	def inner(func):
221	def profiled_func(args, *kwargs):
222	try:
223	profiler = LineProfiler()
224	profiler.add_function(func)
225	for f in follow:
226	profiler.add_function(f)
227	profiler.enable_by_count()
228	return func(args, *kwargs)
229	finally:
230	profiler.print_stats()
231	return profiled_func
232	return inner
233
234	except ImportError: # pragma: no cover
235	def do_profile(follow=None):
236	"Helpful if you accidentally leave in production!"
237	if follow is None:
238	follow = []
239
240	def inner(func):
241	def nothing(args, *kwargs):
242	return func(args, *kwargs)
243	return nothing
244	return inner
245
246
247	def main(*argv): # pragma: no cover
248	"""The Main Event makes no sense to profiling."""
249	raise NotImplementedError("CRITICAL - test profiling main() not implemented. yet?") from None
250
251
252	if __name__ in '__main__': # pragma: no cover
253	exitcode = 2
254	try:
255	exitcode = main(sys.argv[1:])
256	finally:
257	exit(exitcode) # skipcq: PYL-R1722 - intentionally allow overwriteing exit for testing

reactive-firewall-org / multicast / 16954025989

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous