{"id":5914,"date":"2025-02-10T01:31:33","date_gmt":"2025-02-10T09:31:33","guid":{"rendered":"https:\/\/wonghoi.humgar.com\/blog\/?p=5914"},"modified":"2025-12-01T00:03:03","modified_gmt":"2025-12-01T08:03:03","slug":"spyder-traps-for-matlab-users-1-by-default-spyders-f5-run-executes-the-script-from-clean-workspace","status":"publish","type":"post","link":"https:\/\/wonghoi.humgar.com\/blog\/2025\/02\/10\/spyder-traps-for-matlab-users-1-by-default-spyders-f5-run-executes-the-script-from-clean-workspace\/","title":{"rendered":"Spyder traps for MATLAB users (1): By default, Spyder’s F5\/Run executes the script from clean workspace."},"content":{"rendered":"\n

This is another example of open source projects not going through a comprehensive use case study before changing the default behavior, which ended up pulling a prank on some users.<\/p>\n\n\n\n

This time it’s Spyder’s good-intentions trying to proactively prevent user mistakes (such as not keeping track of the workspace) throwing the people who meticulously understand their workspace off. <\/p>\n\n\n\n

I was working on a FT4222 device which should not be opened again if it’s already opened, aka the ft4222 class object exists. So naturally like in MATLAB, at the top of the script I check if the device object already exist and only create\/open it when it’s not already there, like this:<\/p>\n\n\n\n

if 'dev' in locals():\n    pass\nelse:\n    print('Branch')\n    dev = ft4222.openByDescription('FT4222 A')<\/pre>\n\n\n\n
To my surprise it doesn’t work. 'dev' in locals()<\/code> always return False<\/code> every time I press F5, despite when I check again after the script runs, the variable is indeed in there and 'dev' in locals()<\/code> returns True<\/code>. WTF?!<\/p>\n\n\n\n
Turns out I was not alone! Somebody had the exact same idiom as I did. Spyder 4 changed the default behavior<\/a>, and we are supposed to manually check this dialog box entry so the scripts do not run off a clean slate when we press F5!<\/p>\n\n\n\n
\"\"
Spyder 5<\/figcaption><\/figure>\n\n\n\n
\"\"
Spyder 6<\/figcaption><\/figure>\n\n\n\n
It’s an extremely terrible idea to have the IDE muck with the state by default. In MATLAB, if we want the script to start with clean state, we either put clear<\/code> at the top of the script or clearvars -except<\/code> to keep the variable.<\/p>\n\n\n\n
It’s even harder to catch the new default insidious behavior of Spyder given it runs the script from a clean slate from F5\/Run then dump the values to the workspace. It’s now a merge between pre-existing variables in the local()<\/code> workspace and the results of the script from from a blank state! <\/p>\n\n\n\n
The people who decided change to this default behaveior certainly didn’t think through this and rushed to do the obvious to please the careless programmers. If a programmer made a mistake by re-running the script without clearing the workspace and was impacted by the dirty variables, they can always reset everything and get out of this (and learn they should clean up the dirty state through the experience), however, somebody who know what they are doing will not be able to easily find out what they did wrong until they search for a behavior that looked more like a bug from Spyder\/Python! It’s just horrible design choice! MATLAB doesn’t casually to throw users off like this. Damn!<\/p>\n\n\n\n
\n\n\n\n
Also I looked into code cells #%%<\/code> (MATLAB has the equivalent %%<\/code>), but there’s another annoyance in Spyder: block commenting through \"\"\"<\/code> or ```<\/code> pairs is interpreted as output string from runcelll()<\/code>! In other words, runcelll()<\/code> outputs docstrings! So every time you execute the cell, the code you commented out will be concatenated into one long raw string with escape characters and pollute your console screen! Damn!<\/p>\n\n\n\n
\n\n\n\n
Spyder annoyances (3): The shortcut key Ctrl+D to reset console doesn’t work unless there’s nothing half typed in the console.<\/p>\n
<\/div>
<\/path><\/svg><\/i> \"Loading\"<\/p>
<\/div>","protected":false},"excerpt":{"rendered":"
This is another example of open source projects not going through a comprehensive use case study before changing the default behavior, which ended up pulling a prank on some users. This time it’s Spyder’s good-intentions trying to proactively prevent user … Continue reading →<\/span><\/a><\/p>\n
<\/div>\n
<\/path><\/svg><\/i> \"Loading\"<\/p>\n
<\/div>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"footnotes":""},"categories":[10,34],"tags":[],"class_list":["post-5914","post","type-post","status-publish","format-standard","hentry","category-matlab","category-python"],"_links":{"self":[{"href":"https:\/\/wonghoi.humgar.com\/blog\/wp-json\/wp\/v2\/posts\/5914","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wonghoi.humgar.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/wonghoi.humgar.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/wonghoi.humgar.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/wonghoi.humgar.com\/blog\/wp-json\/wp\/v2\/comments?post=5914"}],"version-history":[{"count":9,"href":"https:\/\/wonghoi.humgar.com\/blog\/wp-json\/wp\/v2\/posts\/5914\/revisions"}],"predecessor-version":[{"id":6669,"href":"https:\/\/wonghoi.humgar.com\/blog\/wp-json\/wp\/v2\/posts\/5914\/revisions\/6669"}],"wp:attachment":[{"href":"https:\/\/wonghoi.humgar.com\/blog\/wp-json\/wp\/v2\/media?parent=5914"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/wonghoi.humgar.com\/blog\/wp-json\/wp\/v2\/categories?post=5914"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/wonghoi.humgar.com\/blog\/wp-json\/wp\/v2\/tags?post=5914"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}