#40 - Force garbage collector to run between each tests

Author: js-dieu

docs/sources/changelog.rst

@@ -2,6 +2,10 @@
 Changelog
 =========
 
+* :release:`1.6.1 <2021-08-23>`
+* :bug:`#43` Fixes a bug that prevent sending session tags correctly.
+* :bug:`#40` Force garbage collector to run between tests (better result accuracy)
+
 * :release:`1.6.0 <2021-04-16>`
 * :feature:`#0` Support for python 3.5
 * :feature:`#35` Better support for Doctest item.

docs/sources/configuration.rst

@@ -164,4 +164,15 @@ The following table explains how both fields are mapped:
 
 Note that none of these two fields will be added if:
  * the CI context is incomplete
- * the CI context cannot be computed.
+ * the CI context cannot be computed.
+
+Parameters affecting measures
+-----------------------------
+By default, pytest-monitor runs the garbage collector prior to execute the test function.
+This leads to finer memory measurements. In the case where you want to disable this call to the
+garbage collector, you just have to set the option `--no-gc` on the command line.
+
+.. code-block:: shell
+
+    bash $> pytest --no-gc
+

pytest_monitor/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "1.6.0"
+__version__ = "1.6.1"
 __author__ = "Jean-Sebastien Dieu"

pytest_monitor/pytest_monitor.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+import gc
 import memory_profiler
 import pytest
 import time
@@ -44,6 +45,8 @@ def pytest_addoption(parser):
     group.addoption('--component-prefix', action='store', dest='mtr_component_prefix',
                     help='Prefix each found components with the given value (applies to all tests'
                          ' run in this session).')
+    group.addoption('--no-gc', action="store_true", dest="mtr_no_gc", 
+                    help='Disable garbage collection between tests (may leads to non reliable measures)')
     group.addoption('--description', action='store', default='', dest='mtr_description',
                     help='Use this option to provide a small summary about this run.')
     group.addoption('--tag', action='append', dest='mtr_tags', default=[],
@@ -154,6 +157,8 @@ def prof():
     if not PYTEST_MONITORING_ENABLED:
         wrapped_function()
     else:
+        if pyfuncitem.session.config.option.mtr_no_gc:
+            gc.collect()
         prof()
     return True