Feature: Use pytest.stash instead of protected member (#65)

CHANGES.rst

@@ -1,6 +1,15 @@
 Release Notes
 -------------
 
+3.0.0 (unreleased)
+------------------
+
+* Use `pytest.stash` internally instead of `_metadata`
+
+* Simplify code
+
+  * Thanks to `@LieYangGH <https://github.com/LeiYangGH>`_ for the PR.
+
 2.0.4 (2022-10-30)
 ------------------
 

src/pytest_metadata/hooks.py

@@ -3,5 +3,5 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 
-def pytest_metadata(metadata):
+def pytest_metadata(metadata, config):
     """Called after collecting metadata"""

src/pytest_metadata/plugin.py

@@ -31,6 +31,8 @@
     travis_ci.ENVIRONMENT_VARIABLES,
 ]
 
+metadata_key = pytest.StashKey[dict]()
+
 
 def pytest_addhooks(pluginmanager):
     from . import hooks
@@ -41,13 +43,13 @@ def pytest_addhooks(pluginmanager):
 @pytest.fixture(scope="session")
 def metadata(pytestconfig):
     """Provide test session metadata"""
-    return pytestconfig._metadata
+    return pytestconfig.stash[metadata_key]
 
 
 @pytest.fixture(scope="session")
 def include_metadata_in_junit_xml(metadata, pytestconfig, record_testsuite_property):
     """Provide test session metadata"""
-    metadata_ = pytestconfig._metadata
+    metadata_ = pytestconfig.stash[metadata_key]
     for name, value in metadata_.items():
         record_testsuite_property(name, value)
 
@@ -79,46 +81,47 @@ def pytest_addoption(parser):
 
 @pytest.hookimpl(tryfirst=True)
 def pytest_configure(config):
-    config._metadata = {
+    config.stash[metadata_key] = {
         "Python": platform.python_version(),
         "Platform": platform.platform(),
         "Packages": {
             "pytest": pytest.__version__,
             "pluggy": pluggy.__version__,
         },
     }
-    config._metadata.update({k: v for k, v in config.getoption("metadata")})
-    config._metadata.update(json.loads(config.getoption("metadata_from_json")))
+    config.stash[metadata_key].update({k: v for k, v in config.getoption("metadata")})
+    config.stash[metadata_key].update(
+        json.loads(config.getoption("metadata_from_json"))
+    )
     if config.getoption("metadata_from_json_file"):
         with open(config.getoption("metadata_from_json_file"), "r") as json_file:
-            config._metadata.update(json.load(json_file))
+            config.stash[metadata_key].update(json.load(json_file))
     plugins = dict()
     for plugin, dist in config.pluginmanager.list_plugin_distinfo():
         name, version = dist.project_name, dist.version
         if name.startswith("pytest-"):
             name = name[7:]
         plugins[name] = version
-    config._metadata["Plugins"] = plugins
+    config.stash[metadata_key]["Plugins"] = plugins
 
     for provider in CONTINUOUS_INTEGRATION:
         for var in provider:
             if os.environ.get(var):
-                config._metadata.update({var: os.environ.get(var)})
+                config.stash[metadata_key].update({var: os.environ.get(var)})
 
     if hasattr(config, "workeroutput"):
-        config.workeroutput["metadata"] = config._metadata
-
-    config.hook.pytest_metadata(metadata=config._metadata)
+        config.workeroutput["metadata"] = config.stash[metadata_key]
+    config.hook.pytest_metadata(metadata=config.stash[metadata_key], config=config)
 
 
 def pytest_report_header(config):
     if config.getoption("verbose") > 0:
-        return "metadata: {0}".format(config._metadata)
+        return "metadata: {0}".format(config.stash[metadata_key])
 
 
 @pytest.hookimpl(optionalhook=True)
 def pytest_testnodedown(node):
     # note that any metadata from remote workers will be replaced with the
     # environment from the final worker to quit
     if hasattr(node, "workeroutput"):
-        node.config._metadata.update(node.workeroutput["metadata"])
+        node.config.stash[metadata_key].update(node.workeroutput["metadata"])