Fix for when sys.argv is used in examples #252

lesteve · 2017-06-15T12:53:25Z

The fix is not the nicest one (maybe changing sys.argv inside a try clause and changing it back in except would make it a bit better) but it works ...

lesteve · 2017-07-20T12:04:32Z

ping @Titan-C @choldgraf.

Titan-C · 2017-07-20T12:46:25Z

CHANGES.rst

@@ -4,6 +4,7 @@ Change Log
 git master
 ----------

+<<<<<<< 5eb83a7c61a79656f24e61f5c90c631082265359


Left over from rebase?

Titan-C · 2017-07-20T12:46:44Z

examples/plot_sys_argv.py

@@ -0,0 +1,14 @@
+"""
+Using ``sys.argv`` in examples


This needs to be an RST heading

Titan-C · 2017-07-20T12:49:32Z

sphinx_gallery/gen_rst.py

+
+    argv_orig = sys.argv[:]
+    if block_vars['execute_script']:
+        print('Executing file %s' % src_file)


We currently use the Sphinx logger not the print statement. The execution of the file is stated in generate_dir_rst and not here anymore.

Removed the print statement. I think that is what you were aiming at.

Titan-C · 2017-07-20T12:56:21Z

sphinx_gallery/gen_rst.py

+    argv_orig = sys.argv[:]
+    if block_vars['execute_script']:
+        print('Executing file %s' % src_file)
+        sys.argv[0] = src_file


Is this necessary? sys.argv[0] corresponds to the executing binary, most probably it would be python as example scripts are not executable on their own (there is no shebang). I wouldn't like to have this hint to the src_file, because people might start abusing it. We already don't provide the __file__ variable because of incompatibility with the Jupyter notebooks.

Otherwise sys.argv[0] is sphinx-build leading to a very confusing error message like the one shown in #251 (comment).

Titan-C

There are some issues pending. Maybe the try block is not necessary, changing the sys.argv value can be enough.

Titan-C · 2017-07-20T15:35:04Z

Thanks, merging

lucyleeow · 2019-11-12T17:17:01Z

@lesteve could you explain this a bit more? My understanding is that you cannot use any sys args in your examples .py files as they are set to []. But this doesn't correspond to the example in the documentation where it seems a sys arg is used?

lesteve · 2019-11-13T08:09:23Z

My understanding is that you cannot use any sys args in your examples .py files as they are set to [].

You are right, basically what happens is the equivalent of python your-example.py (i.e. no arguments are provided to the example script).

But this doesn't correspond to the example in the documentation where it seems a sys arg is used?

It is consistent with this example, parsed args: Namespace(option='default') means this is the default value of the parameters so the same thing as what you get when doing python your-example.py. In other words:

❯ python examples/plot_sys_argv.py
sys.argv: ['examples/plot_sys_argv.py']
parsed args: Namespace(option='default')

lucyleeow · 2019-11-13T09:42:48Z

Ah I see, thank you for explaining. You mentioned:

FYI it happens in scikit-learn where some examples are using sys.argv.

And I noticed that there are scikit-learn examples that do use sys.argv (e.g. here). Is this because they are using different configurations or...?

lesteve · 2019-11-13T09:50:30Z

Is this because they are using different configurations or...?

I think that the example you mention is not run by sphinx-gallery. AFAIK scikit-learn sphinx-gallery config only use the examples folder and your file insomewhere in doc/tutorial.

lucyleeow · 2019-11-13T09:53:40Z

Ah okay - that makes sense - thanks for clarifying.

Fix for when sys.argv is used in examples

5eb83a7

lesteve force-pushed the fix-sys-argv branch from 24dd2b6 to 653d2cd Compare July 20, 2017 11:51

Titan-C requested changes Jul 20, 2017

View reviewed changes

Add an entry in the changelog

5630c5c

lesteve force-pushed the fix-sys-argv branch from 653d2cd to 5630c5c Compare July 20, 2017 14:17

Titan-C approved these changes Jul 20, 2017

View reviewed changes

Titan-C merged commit e91ce43 into sphinx-gallery:master Jul 20, 2017

lesteve mentioned this pull request Dec 13, 2017

[MRG] DOC run three more examples using sys.argv scikit-learn/scikit-learn#10301

Merged

lesteve deleted the fix-sys-argv branch November 13, 2019 07:54

larsoner mentioned this pull request Jul 30, 2020

Pass command line arguments to examples #731

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix for when sys.argv is used in examples #252

Fix for when sys.argv is used in examples #252

lesteve commented Jun 15, 2017 •

edited

Loading

lesteve commented Jul 20, 2017

Titan-C Jul 20, 2017

lesteve Jul 20, 2017

Titan-C Jul 20, 2017

lesteve Jul 20, 2017

Titan-C Jul 20, 2017

lesteve Jul 20, 2017

Titan-C Jul 20, 2017

lesteve Jul 20, 2017

Titan-C left a comment

Titan-C commented Jul 20, 2017

lucyleeow commented Nov 12, 2019 •

edited

Loading

lesteve commented Nov 13, 2019

lucyleeow commented Nov 13, 2019

lesteve commented Nov 13, 2019 •

edited

Loading

lucyleeow commented Nov 13, 2019

Fix for when sys.argv is used in examples #252

Fix for when sys.argv is used in examples #252

Conversation

lesteve commented Jun 15, 2017 • edited Loading

lesteve commented Jul 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Titan-C left a comment

Choose a reason for hiding this comment

Titan-C commented Jul 20, 2017

lucyleeow commented Nov 12, 2019 • edited Loading

lesteve commented Nov 13, 2019

lucyleeow commented Nov 13, 2019

lesteve commented Nov 13, 2019 • edited Loading

lucyleeow commented Nov 13, 2019

lesteve commented Jun 15, 2017 •

edited

Loading

lucyleeow commented Nov 12, 2019 •

edited

Loading

lesteve commented Nov 13, 2019 •

edited

Loading