Merge pull request #493 from beer-garden/Current_Request_Function

Add function to provide read-only of the current request

CHANGELOG.rst

@@ -5,6 +5,7 @@ Brewtils Changelog
 ------
 TBD
 
+- Exposed a read only feature to provide the current request that is being processed `from brewtils import get_current_request_read_only`
 - Expand Job Export to include Job id
 
 3.26.3

brewtils/__init__.py

@@ -4,7 +4,11 @@
 from brewtils.config import get_argument_parser, get_connection_info, load_config
 from brewtils.decorators import client, command, parameter, subscribe, system
 from brewtils.log import configure_logging
-from brewtils.plugin import Plugin, RemotePlugin  # noqa F401
+from brewtils.plugin import (
+    get_current_request_read_only,
+    Plugin,
+    RemotePlugin,
+)  # noqa F401
 from brewtils.rest import normalize_url_prefix
 from brewtils.rest.easy_client import EasyClient, get_easy_client
 from brewtils.rest.publish_client import PublishClient
@@ -28,6 +32,7 @@
     "configure_logging",
     "normalize_url_prefix",
     "AutoDecorator",
+    "get_current_request_read_only",
 ]
 
 # Aliased for compatibility

brewtils/plugin.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+import copy
 import json
 import logging
 import logging.config
@@ -46,6 +47,15 @@
 CONFIG = Box(default_box=True)
 
 
+def get_current_request_read_only():
+    """Read-Only instance of Current Request
+
+    Returns a copy of the current request, modifications to this object
+    do not impact the actual current request
+    """
+    return copy.deepcopy(request_context.current_request)
+
+
 class Plugin(object):
     """A Beer-garden Plugin