appmap 2.0.3__tar.gz → 2.0.5__tar.gz

{appmap-2.0.3 → appmap-2.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: appmap
-Version: 2.0.3
+Version: 2.0.5
 Summary: Create AppMap files by recording a Python application.
 Home-page: https://github.com/applandinc/appmap-python
 License: MIT

{appmap-2.0.3 → appmap-2.0.5}/_appmap/instrument.py

@@ -6,7 +6,7 @@ from contextlib import contextmanager
 from . import event
 from .env import Env
 from .event import CallEvent
-from .recorder import Recorder
+from .recorder import Recorder, AppMapTooManyEvents
 from .utils import appmap_tls
 
 logger = Env.current.getLogger(__name__)
@@ -97,6 +97,8 @@ def call_instrumented(f, instance, args, kwargs):
         )
         Recorder.add_event(return_event)
         return ret
+    except AppMapTooManyEvents:
+        raise
     except Exception:  # noqa: E722
         elapsed_time = time.time() - start_time
         Recorder.add_event(

{appmap-2.0.3 → appmap-2.0.5}/_appmap/recorder.py

@@ -10,6 +10,17 @@ logger = Env.current.getLogger(__name__)
 # pylint: disable=global-statement
 _default_recorder = None
 
+# Allow the user to suggest a limit on the number of events that should be added to a Recorder.
+# Depending on how exceptions get processed by the framework, there may be some more added, but it
+# shouldn't be an enormous number.
+_MAX_EVENTS = Env.current.get("APPMAP_MAX_EVENTS")
+if _MAX_EVENTS is not None:
+    _MAX_EVENTS = int(_MAX_EVENTS)
+
+
+class AppMapTooManyEvents(RuntimeError):
+    """Thrown when a recorder has more than APPMAP_MAX_EVENTS"""
+
 
 class Recorder(ABC):
     """
@@ -18,6 +29,8 @@ class Recorder(ABC):
     Note that the abstract methods have implementations for use by subclasses.
     """
 
+    _aborting = False
+
     @property
     @abstractmethod
     def events(self):
@@ -104,6 +117,7 @@ class Recorder(ABC):
         return [perthread, _default_recorder]
 
     def clear(self):
+        Recorder._aborting = False
         self._events = []
 
     def __init__(self, enabled=False):
@@ -130,7 +144,13 @@ class Recorder(ABC):
 
     @abstractmethod
     def _add_event(self, event):
+        if Recorder._aborting:
+            return
+
         self._events.append(event)
+        if _MAX_EVENTS is not None and len(self._events) > _MAX_EVENTS:
+            Recorder._aborting = True
+            raise AppMapTooManyEvents()
 
     @staticmethod
     def _initialize():

{appmap-2.0.3 → appmap-2.0.5}/_appmap/recording.py

@@ -54,6 +54,33 @@ class Recording:
         return False
 
 
+class NoopRecording:
+    """
+    A noop context manager to export as "Recording" instead of class
+    Recording when not Env.current.enabled.
+    """
+
+    def __init__(self, exit_hook=None):
+        self.exit_hook = exit_hook
+
+    def start(self):
+        pass
+
+    def stop(self):
+        pass
+
+    def is_running(self):
+        return False
+
+    def __enter__(self):
+        pass
+
+    def __exit__(self, exc_type, exc_value, tb):
+        if self.exit_hook is not None:
+            self.exit_hook(self)
+        return False
+
+
 def write_appmap(
     appmap, appmap_fname, recorder_type, metadata=None, basedir=Env.current.output_dir
 ):

{appmap-2.0.3 → appmap-2.0.5}/_appmap/test/data/pytest/expected/pytest.appmap.json

@@ -8,95 +8,133 @@
       "name": "appmap",
       "url": "https://github.com/applandinc/appmap-python"
     },
+    "source_location": "test_simple.py:5",
+    "name": "hello world",
+    "feature": "Hello world",
     "app": "Simple",
     "recorder": {
       "name": "pytest",
       "type": "tests"
     },
-    "source_location": "test_simple.py:5",
-    "name": "hello world",
-    "feature": "Hello world",
     "test_status": "succeeded"
   },
   "events": [
     {
-      "defined_class": "simple.Simple",
-      "method_id": "hello_world",
-      "path": "simple.py",
-      "lineno": 8,
       "static": false,
       "receiver": {
-        "class": "simple.Simple",
         "kind": "req",
+        "value": "<simple.Simple object at 0xabcdef>",
         "name": "self",
-        "value": "<simple.Simple object at 0xabcdef>"
+        "class": "simple.Simple"
       },
       "parameters": [],
       "id": 1,
       "event": "call",
-      "thread_id": 1
+      "thread_id": 1,
+      "defined_class": "simple.Simple",
+      "method_id": "hello_world",
+      "path": "simple.py",
+      "lineno": 16
     },
     {
+      "static": false,
+      "receiver": {
+        "kind": "req",
+        "value": "<simple.Simple object at 0xabcdef>",
+        "name": "self",
+        "class": "simple.Simple"
+      },
+      "parameters": [],
+      "id": 2,
+      "event": "call",
+      "thread_id": 1,
       "defined_class": "simple.Simple",
-      "method_id": "hello",
+      "method_id": "get_non_json_serializable",
       "path": "simple.py",
-      "lineno": 2,
+      "lineno": 13
+    },
+    {
       "static": false,
       "receiver": {
-        "class": "simple.Simple",
         "kind": "req",
+        "value": "<simple.Simple object at 0xabcdef>",
         "name": "self",
-        "value": "<simple.Simple object at 0xabcdef>"
+        "class": "simple.Simple"
       },
       "parameters": [],
-      "id": 2,
+      "id": 3,
       "event": "call",
-      "thread_id": 1
+      "thread_id": 1,
+      "defined_class": "simple.Simple",
+      "method_id": "hello",
+      "path": "simple.py",
+      "lineno": 7
     },
     {
       "return_value": {
-        "class": "builtins.str",
-        "value": "'Hello'"
+        "value": "'Hello'",
+        "class": "builtins.str"
       },
-      "parent_id": 2,
-      "id": 3,
+      "parent_id": 3,
+      "id": 4,
       "event": "return",
       "thread_id": 1
     },
     {
-      "defined_class": "simple.Simple",
-      "method_id": "world",
-      "path": "simple.py",
-      "lineno": 5,
       "static": false,
       "receiver": {
-        "class": "simple.Simple",
         "kind": "req",
+        "value": "<simple.Simple object at 0xabcdef>",
         "name": "self",
-        "value": "<simple.Simple object at 0xabcdef>"
+        "class": "simple.Simple"
       },
       "parameters": [],
-      "id": 4,
+      "id": 5,
       "event": "call",
+      "thread_id": 1,
+      "defined_class": "simple.Simple",
+      "method_id": "world",
+      "path": "simple.py",
+      "lineno": 10
+    },
+    {
+      "return_value": {
+        "value": "'world!'",
+        "class": "builtins.str"
+      },
+      "parent_id": 5,
+      "id": 6,
+      "event": "return",
       "thread_id": 1
     },
     {
       "return_value": {
-        "class": "builtins.str",
-        "value": "'world!'"
+        "value": "{0: 'Hello', 1: 'world!'}",
+        "class": "builtins.dict",
+        "properties": [
+          {
+            "name": "0",
+            "class": "builtins.str"
+          },
+          {
+            "name": "1",
+            "class": "builtins.str"
+          }
+        ],
+        "size": 2
       },
-      "parent_id": 4,
-      "id": 5,
+      "parent_id": 2,
+      "id": 7,
       "event": "return",
       "thread_id": 1
     },
     {
       "return_value": {
-        "class": "builtins.str",
-        "value": "'Hello world!'"
+        "value": "'Hello world!'",
+        "class": "builtins.str"
       },
       "parent_id": 1,
-      "id": 6,
+      "id": 8,
       "event": "return",
       "thread_id": 1
     }
@@ -110,22 +148,28 @@
           "name": "Simple",
           "type": "class",
           "children": [
+            {
+              "name": "get_non_json_serializable",
+              "type": "function",
+              "location": "simple.py:13",
+              "static": false
+            },
             {
               "name": "hello",
               "type": "function",
-              "location": "simple.py:2",
+              "location": "simple.py:7",
               "static": false
             },
             {
               "name": "hello_world",
               "type": "function",
-              "location": "simple.py:8",
+              "location": "simple.py:16",
               "static": false
             },
             {
               "name": "world",
               "type": "function",
-              "location": "simple.py:5",
+              "location": "simple.py:10",
               "static": false
             }
           ]

appmap-2.0.5/_appmap/test/data/pytest/simple.py

@@ -0,0 +1,18 @@
+import numpy
+
+zero = numpy.int64(0)
+one = numpy.int64(1)
+
+class Simple:
+    def hello(self):
+        return "Hello"
+
+    def world(self):
+        return "world!"
+
+    def get_non_json_serializable(self):
+        return { zero: self.hello(), one: self.world() }
+
+    def hello_world(self):
+        result = self.get_non_json_serializable()
+        return "%s %s" % (result[zero], result[one])

{appmap-2.0.3 → appmap-2.0.5}/_appmap/test/test_generation.py

@@ -1,5 +1,10 @@
+import json
 import pytest
 
+import numpy as np
+
+from _appmap.generation import AppMapEncoder
+
 
 @pytest.mark.appmap_enabled
 @pytest.mark.usefixtures("with_data_dir")
@@ -48,3 +53,18 @@ class TestGeneration:
             return ret
 
         verify_example_appmap(check_comment, "instance_method")
+
+class TestAppMapEncoder:
+    def test_np_int64_type(self):
+        data = {
+            "value": np.int64(42),
+        }
+        json_str = json.dumps(data, cls=AppMapEncoder)
+        assert '{"value": "42"}' == json_str
+
+    def test_np_array_type(self):
+        data = {
+            "value": np.array([0, 1, 2, 3])
+        }
+        json_str = json.dumps(data, cls=AppMapEncoder)
+        assert '{"value": "[0 1 2 3]"}' == json_str

{appmap-2.0.3 → appmap-2.0.5}/appmap/__init__.py

@@ -8,6 +8,7 @@ import os
 # execute the imports in a function, the modules all get put into the funtion's
 # globals, rather than into appmap's globals.
 _enabled = os.environ.get("APPMAP", None)
+_recording_exported = False
 if _enabled is None or _enabled.upper() == "TRUE":
     if _enabled is not None:
         # Use setdefault so tests can manage _APPMAP as necessary
@@ -18,6 +19,7 @@ if _enabled is None or _enabled.upper() == "TRUE":
         from _appmap.labels import labels  # noqa: F401
         from _appmap.noappmap import decorator as noappmap  # noqa: F401
         from _appmap.recording import Recording  # noqa: F401
+        _recording_exported = True
 
         try:
             from . import django  # noqa: F401
@@ -51,4 +53,11 @@ if _enabled is None or _enabled.upper() == "TRUE":
     else:
         os.environ.pop("_APPMAP", None)
 else:
-    os.environ.setdefault("_APPMAP", "false")
+    os.environ.setdefault("_APPMAP", "false")
+
+if not _recording_exported:
+    # Client code that imports appmap.Recording should run correctly
+    # even when not Env.current.enabled (not APPMAP=true).
+    # This prevents:
+    #   ImportError: cannot import name 'Recording' from 'appmap'...
+    from _appmap.recording import NoopRecording as Recording # noqa: F401

{appmap-2.0.3 → appmap-2.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "appmap"
-version = "2.0.3"
+version = "2.0.5"
 description = "Create AppMap files by recording a Python application."
 readme = "README.md"
 authors = [

appmap-2.0.3/_appmap/test/data/pytest/simple.py

@@ -1,9 +0,0 @@
-class Simple:
-    def hello(self):
-        return "Hello"
-
-    def world(self):
-        return "world!"
-
-    def hello_world(self):
-        return "%s %s" % (self.hello(), self.world())