Document using globals() in python expressions

[jmthomas]

closes #1612

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.56%. Comparing base (67da6a9) to head (c251df4).
Report is 31 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1860   +/-   ##
=======================================
  Coverage   79.56%   79.56%           
=======================================
  Files         519      519           
  Lines       40763    40763           
=======================================
+ Hits        32434    32435    +1     
+ Misses       8329     8328    -1     

Flag	Coverage Δ
python	84.27% <ø> (+<0.01%)	⬆️
ruby-api	48.61% <ø> (ø)
ruby-backend	82.57% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ryanmelt]

Remove change to code-workspace. Add examples to procedures for INST2 with python check_expression

[ryanmelt]

These functions need to use both globals() and locals() otherwise they will not work inside of functions

[jmthomas]

These functions need to use both globals() and locals() otherwise they will not work inside of functions

I don't think so. I was able to put the call inside a method successfully. According to the eval docs, if locals() is not given it defaults to globals().

[ryanmelt]

# Works
def dude():
     y = 10
     eval("print(y)")

# Doesn't work
def dude():
     y = 10
     eval("print(y)", globals())

# Works
def dude():
     y = 10
     eval("print(y)", globals(), locals())

[jmthomas]

This works:

def check():
    value = 0
    wait_check_expression(f"tlm('INST HEALTH_STATUS TEMP1') > {value}", 5, 0.25, globals())

check()

[ryanmelt]

It doesn't really work.
The f string is being evaluated before it gets into wait_check_expression

[ryanmelt]

This won't work:

def check():
    value = 0
    wait_check_expression("tlm('INST HEALTH_STATUS TEMP1') > value", 5, 0.25, globals())

check()

[sonarqubecloud]

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
40.0% Duplication on New Code

See analysis details on SonarQube Cloud