Fix optional animate.py doctests

[kcrisman]

Pretty much all the optional tests in animate.py are fine to do if you possess ImageMagick? and the convert command. Some of them should really then save to a temp file (in the doctest).

This ticket is to make sure that all of them have the actual keyword convert so that optional doctesting works, and to fix those temp files. See #7981 for background.

Apply trac_10655-optional-doctest.patch .

[jhpalmieri]

The patch at #11170 fixes this (although it uses the keyword ImageMagick instead of convert).

[jhpalmieri]

I think this can be closed now, since #11170 has been merged. Can anyone confirm this?

[kcrisman]

Overall it's nearly ready to close. I think you missed one of the tests. See  this spot in animate.py - I think that line 198 needs the keyword too.

Yup.

File "/Users/.../sage-5.0/devel/sage-main/sage/plot/animate.py", line 198:
    sage: b.show() # optional
Exception raised:
    Error: Neither ImageMagick nor ffmpeg appears to be installed. Saving an
    animation to a GIF file or displaying an animation requires one of these
    packages, so please install one of them and try again.

    See www.imagemagick.org and www.ffmpeg.org for more information.
**********************************************************************

If I remembered how to test everything optional except a certain keyword, it wouldn't have taken so much hunting to find that snippet. Didn't you implement that somewhere? But I couldn't find it in the developer guide for 5.0, so it must not have gotten in yet.

[jhpalmieri]

Here's a patch adding optional -- ImageMagick marks to three doctests. If you run something like sage -t --only-optional=ImageMagick, then it will run tests marked with ImageMagick, but I don't think we've implemented anything which says to skip tests marked a certain way.

[kcrisman]

Umm, the second two doctests might be optional for some reason, but they don't require ImageMagick. I just tested this by renaming convert so that

sage -t --only-optional=ImageMagick

failed, and those tests did not shows up as ones that failed. If you look at  the code, too, it doesn't use anything except the initialization (which doesn't need convert) and graphics_array, which clearly doesn't either.

I don't know what you want to do with those, but at any rate this isn't the right solution. Maybe instead put a little note that these don't require convert or something?

Also, please use a more descriptive commit message.

[jhpalmieri]

Hmm. Why are they optional in the first place, then? I'll remove those tags, anyway.

[kcrisman]

Hmm. Why are they optional in the first place, then? I'll remove those tags, anyway.

My thoughts exactly.

Anyway, this looks good. Testing with --only-optional... testing with --optional... good to go.