archive custom user code

[prjemian]

Need a plan to be called from users' custom code that will archive that code for posterity. Similar to how the SPEC macros are recorded.

• Must be simple for user to call: yield from some_name()
• Must provide some value to user (or else they will not use it).
• Must copy user's code into posterity archive.

[prjemian]

Not sure this can be robust for upcoming beam time. Consider moving to later milestone.

[prjemian]

From the proposed plan (support), could identify the caller using introspection. If that caller was defined in a file, archive the entire file contents. Any globals and support routines would thus be archived. How deep to archive (such as archiving some of the imports as well)? Just to file level at first.

Web searches:

• https://stackoverflow.com/questions/2654113/how-to-get-the-callers-method-name-in-the-called-method
• https://duckduckgo.com/?q=python+determine+caller+name&t=ffab&ia=web

They all point to the inspect package and the inspect.getframeinfo() function. We want the object, not the name, since we want to archive source code.

[prjemian]

Still in 2019-06 milestone hoping that we can decide on the name of this routine and set out some initial actions.