ImageInput and ImageOutput docs updated to Python 3. #3866
Conversation
|
I think that it's not so much a "python 2 vs 3" thing, as it is: (a) The examples in the docs are program fragments, not literal full working programs. So 'return' would be fine if this code were inside a function, but doesn't make sense in the main script body. (b) In many cases, I started out with C++ (also fragments, not compilable complete C++ programs) and hand-translated them to make the python equivalents. But I didn't always test them, so probably made plenty of little mistakes, compounded by the fact that I don't use Python every day like I do C++, so my Python can be a little un-fluent, especially when I'm not testing it. In the longer run, I think it would be interesting to set up some kind of fully automated scheme in which most of the sample code in the docs gets run as testsuite items. Or alternately, the other way around -- that they live entirely in the testsuite and get "included" into the docs when code examples are needed. |
|
You're totally right - I don't have much experience with Python 2 and suspected it might be a compatibility issue. But after looking into it, it doesn't seem the return keyword was much different in v2, so that makes sense if it was just un-tested code. I don't know much about testsuite but would be happy to see what needs to be done to link it up with the docs. |
|
I have no doubt that there are also lots of examples in the docs that I wrote in the python2 days and are not valid python3. I bet if I try out what I'm talking about with the testsuite/docs connection on ONE example, then with that existing as a template, it should be fairly easy to convert a lot of the rest of the code examples in the docs to be like that. |
|
I meant, if I do one, it should be easy for OTHER PEOPLE to do the same thing to all the other examples. |
…Foundation#3866) ## Description Fixes AcademySoftwareFoundation#3846 by updating Python examples. Current code examples for [ImageInput](https://openimageio.readthedocs.io/en/latest/imageinput.html) and [ImageOutput](https://openimageio.readthedocs.io/en/latest/imageoutput.html) raise a SyntaxError in Python 3: ```python File "<cwd>\main.py", line 13 return ^^^^^^ SyntaxError: 'return' outside function ``` It seems these code examples might be for Python 2.7. Perhaps it would be worth creating an extra tab instead of replacing the old code? ## Tests Tested on Python 3.11, no issues. ## Checklist: - [x] I have read the [contribution guidelines](https://github.com/OpenImageIO/oiio/blob/master/CONTRIBUTING.md). - [ ] If this is more extensive than a small change to existing code, I have previously submitted a Contributor License Agreement ([individual](https://github.com/OpenImageIO/oiio/blob/master/src/doc/CLA-INDIVIDUAL), and if there is any way my employers might think my programming belongs to them, then also [corporate](https://github.com/OpenImageIO/oiio/blob/master/src/doc/CLA-CORPORATE)). - [x] I have updated the documentation, if applicable. - [ ] I have ensured that the change is tested somewhere in the testsuite (adding new test cases if necessary). - [x] My code follows the prevailing code style of this project.
If you do this, I'd be happy to copy the rest over, at least for the Python examples. |
Description
Fixes #3846 by updating Python examples.
Current code examples for ImageInput and ImageOutput raise a SyntaxError in Python 3:
It seems these code examples might be for Python 2.7. Perhaps it would be worth creating an extra tab instead of replacing the old code?
Tests
Tested on Python 3.11, no issues.
Checklist:
have previously submitted a Contributor License Agreement
(individual, and if there is any way my
employers might think my programming belongs to them, then also
corporate).
(adding new test cases if necessary).