[PATCH v5 19/21] perf python: Add __str__ and __repr__ functions to evlist

Ian Rogers posted 21 patches 3 weeks, 4 days ago
There is a newer version of this series
[PATCH v5 19/21] perf python: Add __str__ and __repr__ functions to evlist
Posted by Ian Rogers 3 weeks, 4 days ago
This allows the values in the evlist to be shown in the REPL like:
```
Python 3.11.9 (main, Jun 19 2024, 00:38:48) [GCC 13.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys.path.insert(0,'/tmp/perf/python')
>>> import perf
>>> perf.parse_events('cycles,data_read')
evlist([cycles,uncore_imc_free_running_0/data_read/,uncore_imc_free_running_1/data_read/])
```

Signed-off-by: Ian Rogers <irogers@google.com>
---
 tools/perf/util/python.c | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/tools/perf/util/python.c b/tools/perf/util/python.c
index 1a53a97c513d..a71bad3418da 100644
--- a/tools/perf/util/python.c
+++ b/tools/perf/util/python.c
@@ -1069,6 +1069,30 @@ static PyObject *pyrf_evlist__item(PyObject *obj, Py_ssize_t i)
 	return Py_BuildValue("O", container_of(pos, struct pyrf_evsel, evsel));
 }
 
+static PyObject *pyrf_evlist__str(PyObject *self)
+{
+	struct pyrf_evlist *pevlist = (void *)self;
+	struct evsel *pos;
+	struct strbuf sb = STRBUF_INIT;
+	bool first = true;
+	PyObject *result;
+
+	strbuf_addstr(&sb, "evlist([");
+	evlist__for_each_entry(&pevlist->evlist, pos) {
+		if (!first)
+			strbuf_addch(&sb, ',');
+		if (!pos->pmu)
+			strbuf_addstr(&sb, evsel__name(pos));
+		else
+			strbuf_addf(&sb, "%s/%s/", pos->pmu->name, evsel__name(pos));
+		first = false;
+	}
+	strbuf_addstr(&sb, "])");
+	result = PyUnicode_FromString(sb.buf);
+	strbuf_release(&sb);
+	return result;
+}
+
 static PySequenceMethods pyrf_evlist__sequence_methods = {
 	.sq_length = pyrf_evlist__length,
 	.sq_item   = pyrf_evlist__item,
@@ -1086,6 +1110,8 @@ static PyTypeObject pyrf_evlist__type = {
 	.tp_doc		= pyrf_evlist__doc,
 	.tp_methods	= pyrf_evlist__methods,
 	.tp_init	= (initproc)pyrf_evlist__init,
+	.tp_repr        = pyrf_evlist__str,
+	.tp_str         = pyrf_evlist__str,
 };
 
 static int pyrf_evlist__setup_types(void)
-- 
2.47.0.163.g1226f6d8fa-goog
Re: [PATCH v5 19/21] perf python: Add __str__ and __repr__ functions to evlist
Posted by Arnaldo Carvalho de Melo 3 weeks, 3 days ago
On Wed, Oct 30, 2024 at 06:42:50PM -0700, Ian Rogers wrote:
> This allows the values in the evlist to be shown in the REPL like:
> ```
> Python 3.11.9 (main, Jun 19 2024, 00:38:48) [GCC 13.2.0] on linux
> Type "help", "copyright", "credits" or "license" for more information.
> >>> import sys
> >>> sys.path.insert(0,'/tmp/perf/python')
> >>> import perf
> >>> perf.parse_events('cycles,data_read')
> evlist([cycles,uncore_imc_free_running_0/data_read/,uncore_imc_free_running_1/data_read/])
> ```

Tested-by: Arnaldo Carvalho de Melo <acme@redhat.com>
 
> Signed-off-by: Ian Rogers <irogers@google.com>
> ---
>  tools/perf/util/python.c | 26 ++++++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
> 
> diff --git a/tools/perf/util/python.c b/tools/perf/util/python.c
> index 1a53a97c513d..a71bad3418da 100644
> --- a/tools/perf/util/python.c
> +++ b/tools/perf/util/python.c
> @@ -1069,6 +1069,30 @@ static PyObject *pyrf_evlist__item(PyObject *obj, Py_ssize_t i)
>  	return Py_BuildValue("O", container_of(pos, struct pyrf_evsel, evsel));
>  }
>  
> +static PyObject *pyrf_evlist__str(PyObject *self)
> +{
> +	struct pyrf_evlist *pevlist = (void *)self;
> +	struct evsel *pos;
> +	struct strbuf sb = STRBUF_INIT;
> +	bool first = true;
> +	PyObject *result;
> +
> +	strbuf_addstr(&sb, "evlist([");
> +	evlist__for_each_entry(&pevlist->evlist, pos) {
> +		if (!first)
> +			strbuf_addch(&sb, ',');
> +		if (!pos->pmu)
> +			strbuf_addstr(&sb, evsel__name(pos));
> +		else
> +			strbuf_addf(&sb, "%s/%s/", pos->pmu->name, evsel__name(pos));
> +		first = false;
> +	}
> +	strbuf_addstr(&sb, "])");
> +	result = PyUnicode_FromString(sb.buf);
> +	strbuf_release(&sb);
> +	return result;
> +}
> +
>  static PySequenceMethods pyrf_evlist__sequence_methods = {
>  	.sq_length = pyrf_evlist__length,
>  	.sq_item   = pyrf_evlist__item,
> @@ -1086,6 +1110,8 @@ static PyTypeObject pyrf_evlist__type = {
>  	.tp_doc		= pyrf_evlist__doc,
>  	.tp_methods	= pyrf_evlist__methods,
>  	.tp_init	= (initproc)pyrf_evlist__init,
> +	.tp_repr        = pyrf_evlist__str,
> +	.tp_str         = pyrf_evlist__str,
>  };
>  
>  static int pyrf_evlist__setup_types(void)
> -- 
> 2.47.0.163.g1226f6d8fa-goog