py rtd validator

Author: ideepcoder

Docs/Project Timeline.md

@@ -23,4 +23,6 @@ https://github.com/ideepcoder/Rtd_Ws_AB_plugin/blob/main/Relay/Server/Python/rel
 https://github.com/ideepcoder/Rtd_Ws_AB_plugin/blob/main/Samples/Client/Python/client.py
 ##### 20250119 - Added Python General Class Wrapper for Vendor/Broker Library
 https://github.com/ideepcoder/Rtd_Ws_AB_plugin/blob/main/Samples/Client/Python/vendor_class_wrapper.py
+##### 20250128 - Added Python utility script to Validate RTD Json
+https://github.com/ideepcoder/Rtd_Ws_AB_plugin/blob/main/Utility%20Scripts/Client/Python/json_validator.py
 

Docs/WSRTD Doc.md

@@ -215,7 +215,7 @@ Inserting historical data into AmiBroker Database
 Work in progress, subject to change.
 > ALL REQUESTS made by **plug-in TO** Server have only "cmd" and "arg fields"
 > Server should REPLY to all above REQUESTS with same "cmd" and "arg" fields. Additionally inserting the "code" which is integer.
-> Code values for OK=200, and OTHER/BAD=400
+> Code values for OK=200 to 299, and OTHER/BAD=400 to 499. Specific codes are not defined yet.
 
 > ALL REQUESTS made by **Server To** Plug-in will have valid "cmd" and "arg" fields. Additionally, all SERVER-side requests will have code=300 which is integer.
 >( The only exceptions is json-RTD and json-HIST formats.)
@@ -336,7 +336,7 @@ R"({"hist")"   // Historical Data
 Explained here [Amibroker Forum](https://forum.amibroker.com/t/documentation-on-batch-data-plugin-command/39269)
 Amibroker [Batch window manual](https://www.amibroker.com/guide/h_batch.html)
 
-Every time the Plug-in receives data, it stores is internally in its own temporary storage and notifies Amibroker of new data. Unfortunately, by design, if the Symbol is not being used by the user is anyway, the plug-in may never be able to "push" the data to AB local Database that is persistent.
+Every time the Plug-in receives data, it stores is internally in its own temporary storage and notifies Amibroker of new data. Unfortunately, by design, if the Symbol is not being used by the user in any way, the plug-in may never be able to "push" the data to AB local Database that is persistent.
 Therefore, user needs to use a Batch file that consists of an empty Analysis Exploration to force all symbols to fetch data. More on this later.
 
 These are some ways to communicate with the Plug-in from the Amibroker User-Interface OR when the websocket is shutdown and therefore not reachable externally.

Utility Scripts/Python/json_validator.py

@@ -0,0 +1,134 @@
+'''
+//      #####   json_validator.py   #####
+//
+// Python utility Script to validate JSON RTD String
+// For Historical data, use DebugView.
+//
+// Performace penalty for Plugin to validate every permutation is unnecessary,
+// as a well written CLIENT=APP already performs checks on RTD. 
+//
+///////////////////////////////////////////////////////////////////////
+// Author: NSM51
+// https://github.com/ideepcoder/Rtd_Ws_AB_plugin/
+// https://forum.amibroker.com/u/nsm51/summary
+// 
+// Any use of this source code must include the above notice, 
+// in the user documentation and internal comments to the code.
+'''
+
+
+import json
+
+## Insert RTD json string in '' quotes to validate
+js = '[{"n":"SYM3","d":20250127,"t":230908,"o":189.45,"h":196.32,"l":181.89,"c":194.59,"v":1212,"bp":186.71,"as":10},\
+       {"n":"SYM2","d":20250127,"t":230908,"o":189.45,"h":196.32,"l":181.89,"c":194.59,"v":1212,"ap":186.71,"bs":10}]'
+
+###############
+# Fields used by RTD json
+
+Field_str           = [ 'n' ]
+Field_num_reqd      = [ 'o', 'h', 'l', 'c' ]
+Field_num_optional  = [ 'v', 'oi', 'x1', 'x2', 's', 'pc', 'bs', 'bp', 'as', 'ap', 'do', 'dh', 'dl' ]
+
+
+def check_str_reqd( f, r ):
+    if f in r:
+        if not isinstance( r[f], str ):
+            print( f"{f} not str in \n{r}" ); return False
+    else:
+        print( f"{f} not found in \n{r}" ); return False
+
+    return True
+
+
+def check_num_reqd( f, r ):
+    if f in r:
+        if not isinstance( r[f], (int, float) ):
+            print( f"{f} not NUM in \n{r}" ); return False
+    else:
+        print( f"{f} not found in \n{r}" ); return False
+
+    return True
+
+
+def check_num_opt( f, r ):
+    if f in r:
+        if not isinstance( r[f], (int, float) ):
+            print( f"{f} not NUM in \n{r}" ); return False
+
+    return True
+
+
+'''
+Function to validate type of mandatory & optional fields
+'''
+def json_rtd_validate( js:str ):
+    
+    if js.startswith('[{"n"'): print(f"\nString MATCH = ok")
+    else: print(f"\nString MATCH failed"); return
+    
+    try:
+        jo = json.loads( js )
+        print( f"Json parsing = ok" )
+    except Exception as e:
+        print( e ); return
+    
+
+    if isinstance( jo, list):
+        print("Outer Array = ok\n")
+    else:
+        print( f"Not Array of Quotes"); return
+
+
+    i = 0;
+    for r in jo:
+
+        if not isinstance( r, dict ): print(f"record should be dict"); return
+
+        ## test mandatory 'n' and type
+        if not check_str_reqd( 'n', r ): return
+
+        ## OHLC, test mandatory and type
+        for ro in Field_num_reqd:
+            if not check_num_reqd( ro, r ): return
+
+        ## Optionals, test type
+        for ro in Field_num_optional:
+            if not check_num_opt( ro, r ): return
+
+        ## Date
+        if 'd' in r:
+            if type( r['d'] ) is not int:
+                print( f"d not int \n{r}" ); return
+
+            if 't' in r:
+                if type( r['t'] ) is not int :
+                    print( f"t not int \n{r}" ); return
+            else:
+                print( f"t is required with d in \n{r}"); return
+
+        elif 'u' in r:
+            if type( r['u'] ) is not int :
+                print( f"u not int \n{r}" ); return
+
+        elif 'g' in r:
+            if type( r['g'] ) is not int :
+                print( f"g not int \n{r}" ); return
+
+        else: print( f"d/u/g not found in \n{r}" ); return
+        
+        print( f"record {i} = ok" ); i += 1 
+
+    return 1
+
+
+#### main()
+if __name__ == '__main__':
+    
+    if json_rtd_validate( js ):
+        print( f"\nFinal validation = OK\n")
+    else:
+        print( f"\nFinal validation = FAILED\n" )
+
+    #print( js )        ## print original string
+

Utility Scripts/Python/notice.txt

@@ -0,0 +1,3 @@
+This plugin should be distributed or redisributed with the Documentation
+file provided in HTML that contains all the Licence information,
+Trademark, Copyright & Other notices.