From d97953e6ff67978da9554e7b4601aedceb21e215 Mon Sep 17 00:00:00 2001 From: "Liguros - Gitlab CI/CD [develop]" Date: Tue, 12 Apr 2022 21:03:09 +0000 Subject: Adding metadata --- dev-python/hunter/Manifest | 2 + .../files/hunter-remove-vendored-colorama.patch | 34 +++++++++ .../remove-setuptools_scm-upper-constraint.patch | 15 ++++ dev-python/hunter/hunter-3.3.8.ebuild | 76 ++++++++++++++++++++ dev-python/hunter/hunter-3.4.3.ebuild | 82 ++++++++++++++++++++++ dev-python/hunter/metadata.xml | 73 +++++++++++++++++++ 6 files changed, 282 insertions(+) create mode 100644 dev-python/hunter/Manifest create mode 100644 dev-python/hunter/files/hunter-remove-vendored-colorama.patch create mode 100644 dev-python/hunter/files/remove-setuptools_scm-upper-constraint.patch create mode 100644 dev-python/hunter/hunter-3.3.8.ebuild create mode 100644 dev-python/hunter/hunter-3.4.3.ebuild create mode 100644 dev-python/hunter/metadata.xml (limited to 'dev-python/hunter') diff --git a/dev-python/hunter/Manifest b/dev-python/hunter/Manifest new file mode 100644 index 000000000000..1cbe63eeff8d --- /dev/null +++ b/dev-python/hunter/Manifest @@ -0,0 +1,2 @@ +DIST hunter-3.3.8.tar.gz 536260 BLAKE2B cdb048798dd831229f3c3ff784b16f94ee45c54bc35eb29e9b228f2736c103dbc39357df82476a2b25310501d33be67474f85c2f5a97a61baca20c8dfc5a725f SHA512 4d715893c805afb5ca709f8c8ce20fbf5ec8540a06c7536862d941a5a4f45b0721f8cd3aa2eeb79c072152d243f4d0ce949431defbdc8c17831f744c3f7ff58a +DIST hunter-3.4.3.tar.gz 538017 BLAKE2B 92ad2b653d0285059ea2f005c6ba9564f357e1ea438a0fe30087f88efa202aaa504bad65985a88484cf7178c24432ac44705098dabc2667328c71e0ee38f718c SHA512 921bb48ac5d384977908dda060e178e623eb7c1e4298cbf3c0a273cab23695f2a2a60221afb257e54cd144399d2b3b55b80ae9a2c7f71ba452894cc86112d5f7 diff --git a/dev-python/hunter/files/hunter-remove-vendored-colorama.patch b/dev-python/hunter/files/hunter-remove-vendored-colorama.patch new file mode 100644 index 000000000000..1fa6342c00e3 --- /dev/null +++ b/dev-python/hunter/files/hunter-remove-vendored-colorama.patch @@ -0,0 +1,34 @@ +--- a/src/hunter/actions.py ++++ b/src/hunter/actions.py +@@ -8,6 +8,8 @@ + from itertools import islice + from os import getpid + ++from colorama import AnsiToWin32 ++ + from . import config + from .util import BUILTIN_SYMBOLS + from .util import CALL_COLORS +@@ -22,7 +20,6 @@ + from .util import frame_iterator + from .util import iter_symbols + from .util import safe_repr +-from .vendor.colorama import AnsiToWin32 + + try: + from threading import get_ident +--- a/src/hunter/util.py ++++ b/src/hunter/util.py +@@ -8,9 +8,9 @@ + from collections import defaultdict + from collections import deque + ++from colorama import Back ++from colorama import Fore ++from colorama import Style +-from .vendor.colorama import Back +-from .vendor.colorama import Fore +-from .vendor.colorama import Style + + try: + import __builtin__ as builtins diff --git a/dev-python/hunter/files/remove-setuptools_scm-upper-constraint.patch b/dev-python/hunter/files/remove-setuptools_scm-upper-constraint.patch new file mode 100644 index 000000000000..5e831b9064d3 --- /dev/null +++ b/dev-python/hunter/files/remove-setuptools_scm-upper-constraint.patch @@ -0,0 +1,15 @@ +--- a/setup.py ++++ b/setup.py +@@ -163,10 +163,10 @@ + ':platform_system != "Windows"': ['manhole >= 1.5'], + }, + setup_requires=[ +- 'setuptools_scm>=3.3.1,!=4.0.0,<6.0', ++ 'setuptools_scm>=3.3.1', + 'cython', + ] if Cython else [ +- 'setuptools_scm>=3.3.1,!=4.0.0,<6.0', ++ 'setuptools_scm>=3.3.1', + ], + entry_points={ + 'console_scripts': [ diff --git a/dev-python/hunter/hunter-3.3.8.ebuild b/dev-python/hunter/hunter-3.3.8.ebuild new file mode 100644 index 000000000000..f6291de9f643 --- /dev/null +++ b/dev-python/hunter/hunter-3.3.8.ebuild @@ -0,0 +1,76 @@ +# Copyright 1999-2021 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI=8 + +PYTHON_COMPAT=( python3_{7,8,9,10} ) +inherit distutils-r1 + +DESCRIPTION="Hunter is a flexible code tracing toolkit" +HOMEPAGE=" + https://github.com/ionelmc/python-hunter + https://pypi.org/project/hunter/ +" +SRC_URI="https://github.com/ionelmc/python-${PN}/archive/v${PV}.tar.gz -> ${P}.tar.gz" +S="${WORKDIR}/python-${P}" +LICENSE="BSD-2" +SLOT="0" +KEYWORDS="~amd64 ~x86" + +RDEPEND="dev-python/colorama[${PYTHON_USEDEP}]" +DEPEND="dev-python/cython[${PYTHON_USEDEP}]" +BDEPEND=" + >=dev-python/setuptools_scm-3.3.1[${PYTHON_USEDEP}] + test? ( + dev-python/aspectlib[${PYTHON_USEDEP}] + dev-python/ipdb[${PYTHON_USEDEP}] + dev-python/manhole[${PYTHON_USEDEP}] + dev-python/process-tests[${PYTHON_USEDEP}] + dev-python/pytest-benchmark[${PYTHON_USEDEP}] + dev-python/six[${PYTHON_USEDEP}] + ) +" + +DOCS=( AUTHORS.rst CHANGELOG.rst README.rst ) +PATCHES=( "${FILESDIR}/remove-setuptools_scm-upper-constraint.patch" ) + +distutils_enable_tests pytest +distutils_enable_sphinx docs ">=dev-python/sphinx-py3doc-enhanced-theme-2.3.2" + +python_compile() { + # native extension build fails with python3.10 + # https://github.com/ionelmc/python-hunter/issues/104 + if [[ ${EPYTHON} == python3.10 ]]; then + SETUPPY_NOEXT="yes" distutils-r1_python_compile + return + fi + + distutils-r1_python_compile + if use test; then + "${EPYTHON}" tests/setup.py build_ext --force --inplace || die + fi +} + +python_test() { + local PUREPYTHONHUNTER + local -x PYTHONPATH="${S}/tests:${BUILD_DIR}/lib:${PYTHONPATH}" + local epytest_args=( + --deselect tests/test_remote.py::test_gdb + --deselect tests/test_remote.py::test_gdb_clean_exit + --deselect tests/test_remote.py::test_manhole + --deselect tests/test_remote.py::test_manhole_clean_exit + ) + + if [[ ${EPYTHON} == python3.10 ]]; then + epytest_args+=( + --deselect tests/test_cookbook.py::test_probe + --deselect tests/test_tracer.py::test_perf_filter[pure] + --deselect tests/test_tracer.py::test_perf_stdlib[pure] + --deselect tests/test_tracer.py::test_perf_actions[pure] + --deselect tests/test_tracer.py::test_proper_backend + ) + PUREPYTHONHUNTER="yes" + fi + + epytest "${epytest_args[@]}" +} diff --git a/dev-python/hunter/hunter-3.4.3.ebuild b/dev-python/hunter/hunter-3.4.3.ebuild new file mode 100644 index 000000000000..0838480e89fb --- /dev/null +++ b/dev-python/hunter/hunter-3.4.3.ebuild @@ -0,0 +1,82 @@ +# Copyright 1999-2022 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI=8 + +PYTHON_COMPAT=( python3_{7,8,9,10} ) + +inherit distutils-r1 + +DESCRIPTION="Hunter is a flexible code tracing toolkit" +HOMEPAGE=" + https://github.com/ionelmc/python-hunter + https://pypi.org/project/hunter/ +" +SRC_URI="https://github.com/ionelmc/python-${PN}/archive/v${PV}.tar.gz -> ${P}.tar.gz" +S="${WORKDIR}/python-${P}" +LICENSE="BSD-2" +SLOT="0" +KEYWORDS="~amd64" + +RDEPEND=">=dev-python/colorama-0.4.4[${PYTHON_USEDEP}]" +DEPEND=" + ${RDEPEND} + dev-python/cython[${PYTHON_USEDEP}] +" +# toml is an indirect dependency (needed by ipdb) +BDEPEND=" + >=dev-python/setuptools_scm-3.3.1[${PYTHON_USEDEP}] + test? ( + dev-python/aspectlib[${PYTHON_USEDEP}] + dev-python/ipdb[${PYTHON_USEDEP}] + dev-python/manhole[${PYTHON_USEDEP}] + dev-python/process-tests[${PYTHON_USEDEP}] + dev-python/pytest-benchmark[${PYTHON_USEDEP}] + dev-python/six[${PYTHON_USEDEP}] + + dev-python/toml[${PYTHON_USEDEP}] + ) +" + +DOCS=( AUTHORS.rst CHANGELOG.rst README.rst ) +PATCHES=( "${FILESDIR}/${PN}-remove-vendored-colorama.patch" ) + +distutils_enable_tests pytest +distutils_enable_sphinx docs ">=dev-python/sphinx-py3doc-enhanced-theme-2.3.2" + +src_prepare() { + # remove vendored colorama + rm -r src/hunter/vendor || die + default +} + +python_compile() { + distutils-r1_python_compile + if use test; then + "${EPYTHON}" tests/setup.py build_ext --force --inplace || die + fi +} + +python_test() { + local PUREPYTHONHUNTER + local -x PYTHONPATH="${S}/tests:${BUILD_DIR}/lib:${PYTHONPATH}" + local epytest_args=( + --deselect tests/test_remote.py::test_gdb + --deselect tests/test_remote.py::test_gdb_clean_exit + --deselect tests/test_remote.py::test_manhole + --deselect tests/test_remote.py::test_manhole_clean_exit + ) + + if [[ ${EPYTHON} == python3.10 ]]; then + epytest_args+=( + --deselect tests/test_cookbook.py::test_probe + --deselect tests/test_tracer.py::test_perf_filter[pure] + --deselect tests/test_tracer.py::test_perf_stdlib[pure] + --deselect tests/test_tracer.py::test_perf_actions[pure] + --deselect tests/test_tracer.py::test_proper_backend + ) + PUREPYTHONHUNTER="yes" + fi + + epytest "${epytest_args[@]}" +} diff --git a/dev-python/hunter/metadata.xml b/dev-python/hunter/metadata.xml new file mode 100644 index 000000000000..c0ae1463675d --- /dev/null +++ b/dev-python/hunter/metadata.xml @@ -0,0 +1,73 @@ + + + + + + lssndrbarbieri@gmail.com + Alessandro Barbieri + + +Hunter is a flexible code tracing toolkit, not for measuring coverage, but for debugging, logging, inspection and other nefarious purposes. It has a simple Python API, a convenient terminal API and a CLI tool to attach to processes. +Design notes + +Hunter doesn't do everything. As a design goal of this library some things are made intentionally austere and verbose (to avoid complexity, confusion and inconsistency). This has few consequences: + + There are Operators but there's no negation operator. Instead you're expected to negate a Query object, eg: ~Q(module='re'). + There are no specialized operators or filters - all filters behave exactly the same. For example: + No filter for packages. You're expected to filter by module with an operator. + No filter for arguments, return values or variables. You're expected to write your own filter function and deal with the problems of poking into objects. + Layering is minimal. There's are some helpers that do some argument processing and conversions to save you some typing but that's about it. + The library doesn't try to hide the mechanics of tracing in Python - it's 1:1 regarding what Python sends to a trace function if you'd be using sys.settrace. + Doesn't have any storage. You are expected to redirect output to a file. + +You should look at it like it's a tool to help you understand and debug big applications, or a framework ridding you of the boring parts of settrace, not something that helps you learn Python. +FAQ +Why not Smiley? + +There's some obvious overlap with smiley but there are few fundamental differences: + + Complexity. Smiley is simply over-engineered: + It uses IPC and a SQL database. + It has a webserver. Lots of dependencies. + It uses threads. Side-effects and subtle bugs are introduced in your code. + It records everything. Tries to dump any variable. Often fails and stops working. + + Why do you need all that just to debug some stuff in a terminal? Simply put, it's a nice idea but the design choices work against you when you're already neck-deep into debugging your own code. In my experience Smiley has been very buggy and unreliable. Your mileage may vary of course. + + Tracing long running code. This will make Smiley record lots of data, making it unusable. + + Now because Smiley records everything, you'd think it's better suited for short programs. But alas, if your program runs quickly then it's pointless to record the execution. You can just run it again. + + It seems there's only one situation where it's reasonable to use Smiley: tracing io-bound apps remotely. Those apps don't execute lots of code, they just wait on network so Smiley's storage won't blow out of proportion and tracing overhead might be acceptable. + + Use-cases. It seems to me Smiley's purpose is not really debugging code, but more of a "non interactive monitoring" tool. + +In contrast, Hunter is very simple: + + Few dependencies. + + Low overhead (tracing/filtering code has an optional Cython extension). + + No storage. This simplifies lots of things. + + The only cost is that you might need to run the code multiple times to get the filtering/actions right. This means Hunter is not really suited for "post-mortem" debugging. If you can't reproduce the problem anymore then Hunter won't be of much help. + +Why not pytrace? + +Pytrace is another tracer tool. It seems quite similar to Smiley - it uses a sqlite database for the events, threads and IPC, thus it's reasonable to expect the same kind of problems. +Why not PySnooper or snoop? + +snoop is a refined version of PySnooper. Both are more suited to tracing small programs or functions as the output is more verbose and less suited to the needs of tracing a big application where Hunter provides more flexible setup, filtering capabilities, speed and brevity. +Why not coverage? + +For purposes of debugging coverage is a great tool but only as far as "debugging by looking at what code is (not) run". Checking branch coverage is good but it will only get you as far. + +From the other perspective, you'd be wondering if you could use Hunter to measure coverage-like things. You could do it but for that purpose Hunter is very "rough": it has no builtin storage. You'd have to implement your own storage. You can do it but it wouldn't give you any advantage over making your own tracer if you don't need to "pre-filter" whatever you're recording. + +In other words, filtering events is the main selling point of Hunter - it's fast (cython implementation) and the query API is flexible enough. + + + ionelmc/python-hunter + hunter + + -- cgit v1.3