tp: several changes for Python API
1. Move everything into a new trace_processor folder inside the Python
folder and add an empty setup.py. Doing this will allow us to correctly
implement setup.py based standalone installation using pip down the line.
2. Add an __init__.py inside the new trace_processor folder to make it
a module we can use.
3. Rename trace_processor_http.py -> http.py now that we have the
wrapping trace_processor folder.
4. Rename api_main.py -> example.py to better reflect its intended
usecase.
5. Check in the trace_processor.proto descriptor (including modifying
the gen_binary_descriptor script to generate this).
6. Add a proto Python module which reads the descriptor and generates
proto factory functions.
These changes were verified to work with both bazel run and execing the
example.py script directly.
Change-Id: I7603edee8741632c6f8d1c7b8ea9d9d17a4c78cd
diff --git a/src/trace_processor/python/api_main.py b/src/trace_processor/python/example.py
similarity index 86%
rename from src/trace_processor/python/api_main.py
rename to src/trace_processor/python/example.py
index b4be75d..cb16f52 100644
--- a/src/trace_processor/python/api_main.py
+++ b/src/trace_processor/python/example.py
@@ -15,19 +15,21 @@
import argparse
-from trace_processor_http import TraceProcessorHttp
+from trace_processor.http import TraceProcessorHttp
def main():
# Parse arguments passed from command line
- args = parser.parse_args()
parser = argparse.ArgumentParser()
parser.add_argument(
"-a",
"--address",
help="Address at which trace_processor is being run, e.g. 127.0.0.1:9001",
+ required=True,
type=str)
- parser.add_argument("-f", "--file", help="Absolute path to trace", type=str)
+ parser.add_argument(
+ "-f", "--file", help="Absolute path to trace", required=True, type=str)
+ args = parser.parse_args()
# TODO(@aninditaghosh): Load trace into trace_processor_shell
diff --git a/src/trace_processor/python/setup.py b/src/trace_processor/python/setup.py
new file mode 100644
index 0000000..e2f6a86
--- /dev/null
+++ b/src/trace_processor/python/setup.py
@@ -0,0 +1,2 @@
+# TODO(aninditaghosh): fill this in when we're ready to support
+# local, pip-based installation.
\ No newline at end of file
diff --git a/src/trace_processor/python/trace_processor/__init__.py b/src/trace_processor/python/trace_processor/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/src/trace_processor/python/trace_processor/__init__.py
diff --git a/src/trace_processor/python/trace_processor/descriptor.py b/src/trace_processor/python/trace_processor/descriptor.py
new file mode 100644
index 0000000..9fe90fe
--- /dev/null
+++ b/src/trace_processor/python/trace_processor/descriptor.py
@@ -0,0 +1,24 @@
+#!/usr/bin/env python3
+# Copyright (C) 2020 The Android Open Source Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+
+import os
+
+
+# This function lives in its own module to allow us to use a different
+# mechanism of loading depending on the build system.
+def read_descriptor():
+ ws = os.path.dirname(__file__)
+ with open(os.path.join(ws, 'trace_processor.descriptor'), 'rb') as x:
+ return x.read()
diff --git a/src/trace_processor/python/trace_processor_http.py b/src/trace_processor/python/trace_processor/http.py
similarity index 86%
rename from src/trace_processor/python/trace_processor_http.py
rename to src/trace_processor/python/trace_processor/http.py
index fbe1f85..f70b0ea 100644
--- a/src/trace_processor/python/trace_processor_http.py
+++ b/src/trace_processor/python/trace_processor/http.py
@@ -15,10 +15,13 @@
from urllib import request
+from .protos import ProtoFactory
+
class TraceProcessorHttp:
def __init__(self, url):
+ self.protos = ProtoFactory()
self.url = 'http://' + url
def parse(self, chunk):
@@ -34,4 +37,6 @@
def status(self):
req = request.Request(self.url + '/status')
with request.urlopen(req) as f:
- return f.read()
+ result = self.protos.StatusResult()
+ result.ParseFromString(f.read())
+ return result
diff --git a/src/trace_processor/python/trace_processor/protos.py b/src/trace_processor/python/trace_processor/protos.py
new file mode 100644
index 0000000..652a2fe
--- /dev/null
+++ b/src/trace_processor/python/trace_processor/protos.py
@@ -0,0 +1,38 @@
+# Copyright (C) 2020 The Android Open Source Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+
+from google.protobuf import descriptor_pb2, message_factory
+from google.protobuf.descriptor_pool import DescriptorPool
+
+from .descriptor import read_descriptor
+
+
+class ProtoFactory:
+
+ def __init__(self):
+ descriptor_bytes = read_descriptor()
+
+ file_desc_set_pb2 = descriptor_pb2.FileDescriptorSet()
+ file_desc_set_pb2.MergeFromString(descriptor_bytes)
+
+ self.descriptor_pool = DescriptorPool()
+
+ for f_desc_pb2 in file_desc_set_pb2.file:
+ self.descriptor_pool.Add(f_desc_pb2)
+
+ def create_message_factory(message_type):
+ message_desc = self.descriptor_pool.FindMessageTypeByName(message_type)
+ return message_factory.MessageFactory().GetPrototype(message_desc)
+
+ self.StatusResult = create_message_factory('perfetto.protos.StatusResult')
diff --git a/src/trace_processor/python/trace_processor/trace_processor.descriptor b/src/trace_processor/python/trace_processor/trace_processor.descriptor
new file mode 100644
index 0000000..f1479f8
--- /dev/null
+++ b/src/trace_processor/python/trace_processor/trace_processor.descriptor
Binary files differ
diff --git a/src/trace_processor/python/trace_processor/trace_processor.descriptor.sha1 b/src/trace_processor/python/trace_processor/trace_processor.descriptor.sha1
new file mode 100644
index 0000000..6470ee6
--- /dev/null
+++ b/src/trace_processor/python/trace_processor/trace_processor.descriptor.sha1
@@ -0,0 +1,5 @@
+
+// SHA1(tools/gen_binary_descriptors)
+// b70b596b8569e2a2482f869a8eeb49f5ee801530
+// SHA1(protos/perfetto/trace_processor/trace_processor.proto)
+// 286407410c59c2d9b7805f7d28b61c3809c9cdc5
