summaryrefslogtreecommitdiff
path: root/dev-python/hunter
diff options
context:
space:
mode:
Diffstat (limited to 'dev-python/hunter')
-rw-r--r--dev-python/hunter/Manifest2
-rw-r--r--dev-python/hunter/files/fix_backend.patch12
-rw-r--r--dev-python/hunter/hunter-3.6.0.ebuild87
-rw-r--r--dev-python/hunter/hunter-3.6.1.ebuild77
-rw-r--r--dev-python/hunter/metadata.xml44
5 files changed, 112 insertions, 110 deletions
diff --git a/dev-python/hunter/Manifest b/dev-python/hunter/Manifest
index 6d38f0230dac..4ab653d99da8 100644
--- a/dev-python/hunter/Manifest
+++ b/dev-python/hunter/Manifest
@@ -1 +1 @@
-DIST hunter-3.6.0.gh.tar.gz 626304 BLAKE2B 8cef43f6427863724b6a7f848ee938011b8de2100c12c4f7cd049156733da0076f3d04d74328aeff06edeab6e5d85a9dd564b6281644a1e6172741573f066127 SHA512 5b5a6e7e2f26f71ff151d40fe0b660141ff2d2637fa9a226e9a1a4ead5267cf1e851baa0a439a94aa4b537db3fbdc5cd660304f64ad08ee90a115516c3848547
+DIST hunter-3.6.1.gh.tar.gz 626351 BLAKE2B 077d61faa8348434ca4bb76b4f703ea341d10df0a822cd57575881082c009f3d94f3808642bd569726c20450d42c5d24a95919f099701e31cf44a50cbeb2f0b7 SHA512 1215da594c51cfce6341e3193de14a3386de4d28f0e0745c11b8bd6ba45d33d91628b8abfb528716968f119fa6ef64e7e2fb9ee222af16bfc8519eda354edd11
diff --git a/dev-python/hunter/files/fix_backend.patch b/dev-python/hunter/files/fix_backend.patch
new file mode 100644
index 000000000000..5410ea8f7d9f
--- /dev/null
+++ b/dev-python/hunter/files/fix_backend.patch
@@ -0,0 +1,12 @@
+Upstream uses custom file as backend
+--- a/pyproject.toml
++++ b/pyproject.toml
+@@ -4,7 +4,7 @@ requires = [
+ "wheel",
+ "setuptools_scm>=3.3.1,!=4.0.0",
+ ]
+-build-backend = "backend"
++build-backend = "setuptools.build_meta"
+ backend-path = ["build_backend"]
+
+ [tool.ruff.per-file-ignores]
diff --git a/dev-python/hunter/hunter-3.6.0.ebuild b/dev-python/hunter/hunter-3.6.0.ebuild
deleted file mode 100644
index ac4608a4b612..000000000000
--- a/dev-python/hunter/hunter-3.6.0.ebuild
+++ /dev/null
@@ -1,87 +0,0 @@
-# Copyright 1999-2024 Gentoo Authors
-# Distributed under the terms of the GNU General Public License v2
-
-EAPI=8
-
-PYTHON_COMPAT=( python3_{8,9,10,11,12} )
-DISTUTILS_USE_PEP517=standalone
-DISTUTILS_EXT=1
-inherit distutils-r1 multiprocessing
-
-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}.gh.tar.gz"
-S="${WORKDIR}/python-${P}"
-TEST_S="${S}_test"
-
-LICENSE="BSD-2"
-SLOT="0"
-KEYWORDS="~amd64"
-
-BDEPEND="
- dev-python/cython[${PYTHON_USEDEP}]
- dev-python/setuptools[${PYTHON_USEDEP}]
- dev-python/setuptools-scm[${PYTHON_USEDEP}]
- test? (
- dev-debug/gdb
- dev-python/aspectlib[${PYTHON_USEDEP}]
- dev-python/ipdb[${PYTHON_USEDEP}]
- dev-python/manhole[${PYTHON_USEDEP}]
- dev-python/process-tests[${PYTHON_USEDEP}]
- dev-python/six[${PYTHON_USEDEP}]
- )
-"
-
-DOCS=( AUTHORS.rst CHANGELOG.rst README.rst )
-
-EPYTEST_DESELECT=(
- # broken
- #tests/test_tracer.py::test_source_cython
- tests/test_tracer.py::test_fullsource_cython
-
- # need pytest-benchmark
- tests/test_cookbook.py::test_probe
- tests/test_tracer.py::test_perf_actions
- tests/test_tracer.py::test_perf_filter
- tests/test_tracer.py::test_perf_stdlib
-
- # flaky
- tests/test_remote.py
-)
-
-distutils_enable_tests pytest
-
-distutils_enable_sphinx docs \
- ">=dev-python/sphinx-py3doc-enhanced-theme-2.3.2"
-
-src_unpack() {
- default
-
- if use test; then
- cp -a "${S}" "${TEST_S}" || die
- mv -f "${TEST_S}"/tests/setup.py "${TEST_S}"/setup.py || die
- fi
-}
-
-src_prepare() {
- find . -name '*.c' -delete || die "removing csources failed"
- distutils-r1_src_prepare
-}
-
-python_compile() {
- distutils-r1_python_compile
-
- if use test; then
- einfo " Building tests"
- cd "${TEST_S}" || die
- esetup.py build_ext -j $(makeopts_jobs) --inplace
- fi
-}
-
-python_test() {
- cd "${TEST_S}"/tests || die
- epytest
-}
diff --git a/dev-python/hunter/hunter-3.6.1.ebuild b/dev-python/hunter/hunter-3.6.1.ebuild
new file mode 100644
index 000000000000..2e08d1100a0b
--- /dev/null
+++ b/dev-python/hunter/hunter-3.6.1.ebuild
@@ -0,0 +1,77 @@
+# Copyright 1999-2024 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI=8
+
+DISTUTILS_EXT=1
+PYTHON_COMPAT=( python3_{8,9,10,11,12} )
+DISTUTILS_USE_PEP517=setuptools
+
+DOCS_BUILDER="sphinx"
+DOCS_DEPEND="dev-python/sphinx-py3doc-enhanced-theme"
+DOCS_DIR="docs"
+
+inherit distutils-r1 docs
+
+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}.gh.tar.gz"
+S="${WORKDIR}/python-${P}"
+
+LICENSE="BSD-2"
+SLOT="0"
+KEYWORDS="~amd64"
+
+BDEPEND="
+ dev-python/cython[${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=(
+ # Upstream uses a custom file to define backend as setuptools
+ "${FILESDIR}/fix_backend.patch"
+)
+
+distutils_enable_tests pytest
+
+EPYTEST_DESELECT=(
+ # I think it needs internet
+ tests/test_remote.py::test_manhole_clean_exit
+ # Need a py.io module that does not seem to exist
+ tests/test_util.py::test_safe_repr
+ # Permission denied in a chroot
+ tests/test_remote.py::test_gdb
+ tests/test_remote.py::test_gdb_clean_exit
+)
+
+python_test() {
+ # Need to import files in tests folder
+ cd "${S}/tests" || die
+ if [[ "${EPYTHON}" == "python3.12" ]]; then
+ EPYTEST_DESELECT+=(
+ # From what I could understand, it fail because of a change in pathlib in 3.12
+ tests/test_cookbook.py::test_profile
+ tests/test_integration.py::test_errorsnooper
+ tests/test_integration.py::test_errorsnooper_fastmode
+ )
+ fi
+ epytest
+}
+
+src_prepare() {
+ # Need a module that does not exist (see https://github.com/ionelmc/python-hunter/issues/116)
+ rm "${S}/tests/test_tracer.py" || die
+ distutils-r1_src_prepare
+}
diff --git a/dev-python/hunter/metadata.xml b/dev-python/hunter/metadata.xml
index a6a03d973651..6611781299db 100644
--- a/dev-python/hunter/metadata.xml
+++ b/dev-python/hunter/metadata.xml
@@ -7,13 +7,13 @@ 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.
+ 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
@@ -21,31 +21,31 @@ 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.
+ 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.
+ 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.
+ 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.
+ 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.
+ 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.
+ 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.
+ Few dependencies.
- Low overhead (tracing/filtering code has an optional Cython extension).
+ Low overhead (tracing/filtering code has an optional Cython extension).
- No storage. This simplifies lots of things.
+ 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.
+ 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?
@@ -60,7 +60,7 @@ For purposes of debugging coverage is a great tool but only as far as "debugging
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.
- </longdescription>
+ </longdescription>
<upstream>
<changelog>https://python-hunter.readthedocs.io/en/latest/changelog.html</changelog>
<doc>https://python-hunter.readthedocs.io/</doc>