将日志文件转义为 json 字符串，用于使用 Python 调用 REST

Question

I have a log file with all kind of character that need escaping, quote, double quote, forward and backward slashes, URL, other jsons.

I want to send this file as part of REST request which is in JSON format, how do I escape my file in Python to be ready for transporting.

Example of my file:

(12/5/2020 8:20:39 PM) My Project: Log directory created
(12/5/2020 8:20:43 PM) My Project: SF auth result: {vOPDetail,},{vOPResponseCode,},{vOPState,success},{vOutputToken,00D4W},{vOpResponseBody,},{vOPType,},{vOPInstanceUrl,https://test.my.salesforce.com}
(12/5/2020 8:20:43 PM) My Project: Token: "00D4W0000"
(12/5/2020 8:20:43 PM) My Project: URL: https://test.my.salesforce.com

My REST call look like this:

PATCH https://test.my.salesforce.com/services/data/v49.0/sobjects/My_Object/a2P4W00000272ujUAA

Body

{
    "My_Namespace__My_Object__c" : "$Log$"
}

Where $Log$ is where the log file will go

The actual REST call is in another language, I just need PYTHON to escape the log file to be ready for transport. Here is what I tried and does NOT work:

import json
def EscapeJSONString(input):
    return json.dumps(input)

The input here is the entirely of the log file which is read using a different language, due to my circumstances I can not escape the log file in the other language, I can just read it as is.

The other language just call this python function EscapeJSONString and provide the log as input and then save the output to a variable.

Answer 1

Jumping from a language to the other just to escape a string doesn't sound like the best solution. Transfering a large log file this way also seems very inefficient, why not skip REST for this specific call and have an HTTP request to get the log in it's raw format.

But if you want to do it this way, json.dumps() does the escaping you need for string variables as values, so you can build en entire json like so:

import json
def EscapeJSONString(input):
    return json.dumps({"My_Namespace__My_Object__c": input})

Answer 2

It's hard to tell what input is here, but you need to mention how this function actually gets executed, because the file content does get properly escaped if read directly in Python

Note: Forward slashes and brackets don't need escaped

>>> import json
>>> with open('/tmp/data.txt') as f:
...     print(json.dumps({"log": f.read()}))
... )
...
{"log": "(12/5/2020 8:20:39 PM) My Project: Log directory created\n(12/5/2020 8:20:43 PM) My Project: SF auth result: {vOPDetail,},{vOPResponseCode,},{vOPState,success},{vOutputToken,00D4W},{vOpResponseBody,},{vOPType,},{vOPInstanceUrl,https://test.my.salesforce.com}\n(12/5/2020 8:20:43 PM) My Project: Token: \"00D4W0000\"\n(12/5/2020 8:20:43 PM) My Project: URL: https://test.my.salesforce.com\n"}

Assuming input is a string, then you'd be returning a string, not a JSON object for the HTTP body