Merge branch 'mnt/pyfeeds-env-var' into 'master'

MNT: Set a `PYFEEDS_TESTING` environment variable so `feedsRun` scripts can determine whether they are being called by `pyfeeds`, or by other means.

See merge request !37

CHANGELOG.rst

@@ -2,6 +2,13 @@
 =====================
 
 
+0.12.4 (Thursday 18th January 2024)
+-----------------------------------
+
+
+* Pyfeeds now sets a ``PYFEEDS_TESTING=1`` environment variable when calling
+  `feedsRun` scripts.
+
 
 0.12.3 (Friday 8th December 2023)
 ---------------------------------

doc/writing_a_test.md

@@ -227,6 +227,12 @@ A `pyfeeds` test is called with three parameters:
      previously-generated benchmark data for the test, if it exists.
 
 
+When `pyfeeds` calls a `feedsRun` script, it sets an environment variable -
+`PYFEEDS_TESTING=1`. This may be useful for `feedsRun` scripts which are intended
+to be callable both from `pyfeeds`, and through other means, and which need to
+behave differently depending on how they are called.
+
+
 ## Writing your test in Python
 
 

pyfeeds/__init__.py

@@ -5,7 +5,7 @@
 # Author: Paul McCarthy <pauldmccarthy@gmail.com>
 #
 
-__version__ = '0.12.3'
+__version__ = '0.12.4'
 """The pyfeeds version number. """
 
 

pyfeeds/testing.py

@@ -450,6 +450,11 @@ def runTests(pyf):
     env               = os.environ.copy()
     env['PYTHONPATH'] = op.pathsep.join([thisDir, env.get('PYTHONPATH', '')])
 
+    # set PYFEEDS_TESTING=1 in case test scripts
+    # want to know whether they are being executed
+    # by pyfeeds or via some other mechanism.
+    env['PYFEEDS_TESTING'] = '1'
+
     # For each test we store a dictionary containing
     # the results of running the test. Each result
     # dict contains: