appmap 2.0.6__tar.gz → 2.0.8__tar.gz

{appmap-2.0.6 → appmap-2.0.8}/PKG-INFO

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

{appmap-2.0.6 → appmap-2.0.8}/_appmap/event.py

@@ -111,7 +111,9 @@ def describe_value(name, val, max_depth=5):
         "object_id": id(val),
         "value": display_string(val),
     }
-    ret.update(_describe_schema(name, val, 0, max_depth))
+    if Env.current.display_params:
+        ret.update(_describe_schema(name, val, 0, max_depth))
+
     if any(_is_list_or_dict(type(val))):
         ret["size"] = len(val)
 
@@ -455,7 +457,11 @@ class FuncReturnEvent(ReturnEvent):
 
     def __init__(self, parent_id, elapsed, return_value):
         super().__init__(parent_id, elapsed)
-        self.return_value = describe_value(None, return_value)
+        # Import here to prevent circular dependency
+        # pylint: disable=import-outside-toplevel
+        from _appmap.instrument import recording_disabled # noqa: F401
+        with recording_disabled():
+            self.return_value = describe_value(None, return_value)
 
 
 class HttpResponseEvent(ReturnEvent):

{appmap-2.0.6 → appmap-2.0.8}/_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, AppMapTooManyEvents
+from .recorder import Recorder, AppMapLimitExceeded
 from .utils import appmap_tls
 
 logger = Env.current.getLogger(__name__)
@@ -15,11 +15,12 @@ logger = Env.current.getLogger(__name__)
 @contextmanager
 def recording_disabled():
     tls = appmap_tls()
+    original_value = tls.get("instrumentation_disabled")
     tls["instrumentation_disabled"] = True
     try:
         yield
     finally:
-        tls["instrumentation_disabled"] = False
+        tls["instrumentation_disabled"] = original_value
 
 
 def is_instrumentation_disabled():
@@ -89,6 +90,7 @@ def call_instrumented(f, instance, args, kwargs):
     call_event_id = call_event.id
     start_time = time.time()
     try:
+        Recorder.check_time(start_time)
         ret = f.fn(*args, **kwargs)
         elapsed_time = time.time() - start_time
 
@@ -97,7 +99,7 @@ def call_instrumented(f, instance, args, kwargs):
         )
         Recorder.add_event(return_event)
         return ret
-    except AppMapTooManyEvents:
+    except AppMapLimitExceeded:
         raise
     except Exception:  # noqa: E722
         elapsed_time = time.time() - start_time

{appmap-2.0.6 → appmap-2.0.8}/_appmap/recorder.py

@@ -1,4 +1,5 @@
 import threading
+import time
 import traceback
 from abc import ABC, abstractmethod
 
@@ -17,11 +18,23 @@ _MAX_EVENTS = Env.current.get("APPMAP_MAX_EVENTS")
 if _MAX_EVENTS is not None:
     _MAX_EVENTS = int(_MAX_EVENTS)
 
+_MAX_TIME = Env.current.get("APPMAP_MAX_TIME")
+if _MAX_TIME is not None:
+    _MAX_TIME = int(_MAX_TIME)
 
-class AppMapTooManyEvents(RuntimeError):
+
+class AppMapLimitExceeded(RuntimeError):
+    """Class of events thrown when some limit has been exceeded"""
+
+
+class AppMapTooManyEvents(AppMapLimitExceeded):
     """Thrown when a recorder has more than APPMAP_MAX_EVENTS"""
 
 
+class AppMapSessionTooLong(AppMapLimitExceeded):
+    """Throw when an individual recording session has exceeded APPMAP_MAX_TIME"""
+
+
 class Recorder(ABC):
     """
     A base class for Recorders.
@@ -97,6 +110,13 @@ class Recorder(ABC):
     def stop_recording(cls):
         return cls.get_current()._stop_recording()  # pylint: disable=protected-access
 
+    @classmethod
+    def check_time(cls, event_time):
+        if _MAX_TIME is None:
+            return
+        if event_time - cls.get_current()._start_time > _MAX_TIME:
+            raise AppMapSessionTooLong(f"Session exceeded {_MAX_TIME} seconds")
+
     @classmethod
     def add_event(cls, event):
         """
@@ -124,6 +144,7 @@ class Recorder(ABC):
         self._events = []
         self._enabled = enabled
         self.start_tb = None
+        self._start_time = None
 
     @abstractmethod
     def _start_recording(self):
@@ -134,6 +155,7 @@ class Recorder(ABC):
             raise RuntimeError("Recording already in progress")
         self.start_tb = traceback.extract_stack()
         self._enabled = True
+        self._start_time = time.time()
 
     @abstractmethod
     def _stop_recording(self):
@@ -150,7 +172,7 @@ class Recorder(ABC):
         self._events.append(event)
         if _MAX_EVENTS is not None and len(self._events) > _MAX_EVENTS:
             Recorder._aborting = True
-            raise AppMapTooManyEvents()
+            raise AppMapTooManyEvents(f"Session exceeded {_MAX_EVENTS} events")
 
     @staticmethod
     def _initialize():

{appmap-2.0.6 → appmap-2.0.8}/_appmap/test/data/example_class.py

@@ -110,6 +110,9 @@ class ExampleClass(Super, ClassMethodMixin):
     def with_comment(self):
         return True
 
+    def return_self(self):
+        return self
+
 
 def modfunc():
     return "Hello world!"

{appmap-2.0.6 → appmap-2.0.8}/_appmap/test/test_events.py

@@ -105,3 +105,15 @@ class TestEvents:
             # MagicMock. (If it's broken, we may not get here at all,
             # because the assertion above may fail.)
             param.__repr__.assert_called_once_with()
+
+    def test_describe_return_value_recursion_protection(self):
+        r = appmap.Recording()
+        with r:
+            # pylint: disable=import-outside-toplevel
+            from example_class import ExampleClass
+
+            ExampleClass().return_self()
+        # There should be no event for method another_method which is called by __repr__.
+        assert [e.method_id for e in r.events if e.event == "call" and hasattr(e, "method_id")] == [
+            "return_self"
+        ]

{appmap-2.0.6 → appmap-2.0.8}/pyproject.toml

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

{appmap-2.0.6 → appmap-2.0.8}/vendor/_appmap/wrapt/wrappers.py

@@ -457,9 +457,11 @@ class ObjectProxy(with_metaclass(_ObjectProxyMetaType)):
         raise NotImplementedError(
                 'object proxy must define __reduce_ex__()')
 
+    # Return the qualname of the wrapped function instead of a tuple. This allows an instance of
+    # subclasses to be pickled as the function it wraps. This seems to be adequate for generating
+    # AppMaps.
     def __reduce_ex__(self, protocol):
-        raise NotImplementedError(
-                'object proxy must define __reduce_ex__()')
+         return self.__wrapped__.__qualname__
 
 class CallableObjectProxy(ObjectProxy):
 
@@ -740,12 +742,9 @@ class FunctionWrapper(_FunctionWrapperBase):
     # new FunctionWrapper will be created. If it doesn't, then __reduce_ex__ can simply return a
     # string, which would cause deepcopy to return the original FunctionWrapper.
     #
-    # Update: We'll return the qualname of the wrapped function instead of a tuple allows a
-    # FunctionWrapper to be pickled (as the function it wraps). This seems to be adequate for
-    # generating AppMaps, so go with that.
 
-    def __reduce_ex__(self, protocol):
-         return self.__wrapped__.__qualname__
+    # def __reduce_ex__(self, protocol):
+    #      return self.__wrapped__.__qualname__
  
          # return FunctionWrapper, (
          #     self.__wrapped__,