test: Fix docs test, used wrong namespace #4090
Conversation
Signed-off-by: Larry Gritz <lg@larrygritz.com>
| @@ -263,10 +263,10 @@ def example_make_texture(): | |||
| config["maketx:filtername"] = "lanczos3" | |||
| config["maketx:opaque_detect"] = 1 | |||
|
|
|||
| ok = ImageBufAlgo.make_texture (OpenImageIO.MakeTxTexture, | |||
| ok = ImageBufAlgo.make_texture (oiio.MakeTxTexture, | |||
There was a problem hiding this comment.
For consistency with other examples, should this use MakeTxTexture instead of oiio.MakeTxTexture? All the other examples use stuff imported from from OpenImageIO import *.
There was a problem hiding this comment.
Sure.
I'm not very immersed in Python culture. Remembering that this is not just a test, but its snippets will be directly used in the documentation as examples for the API calls, what's customary when documenting a library and providing code examples? Is it typical to omit any namespacing at all? Or to use a namespace in the examples? To always use the full namespace?
There was a problem hiding this comment.
Numpy example: https://numpy.org/doc/1.26/user/absolute_beginners.html#how-to-import-numpy
They show how to import, use a short namespace alias, and then they use the namespace everywhere in the rest of the examples. I think this is wise, as for beginners it more easily distinguishes between the Numpy API and things that might be features of Python itself.
I think we should do the same. So I want to keep the use of the oiio namespace here. And let's make a mental note that, separately, we should find anyplace in the examples that does a full from OpenImageIO import * and change that to use a namespace to be more clear.
There was a problem hiding this comment.
If possible, it's recommended to avoid using start imports. My initial comment was to keep the consistency, but it would be a good idea, like you suggest, to instead use import OpenImageIO or import OpenImageIO as oiio.
There was a problem hiding this comment.
Agreed. In general, in both C++ and Python, I think it's better style to always use the namespacing explicitly, for clarity. At least as a default, and take exceptions one by one in cases where removing the namespacing clearly the code more readable.
There was a problem hiding this comment.
I'm not sure where the * import came from. Git blame says me, of course, but it's contrary to my usual style, so I think I just wasn't considering it very carefully at that moment.
|
Look ok other than that quibble? |
…4090) We did `import OpenImageIO as oiio` then instead of using `oiio`, we used `OpenImageIO`. This was failing sometimes. Frankly, I'm not sure why it ever worked. Maybe it works on some versions of Python but not others? I dunno. But this fixes it everywhere and is clearly correct. Signed-off-by: Larry Gritz <lg@larrygritz.com>
…4090) We did `import OpenImageIO as oiio` then instead of using `oiio`, we used `OpenImageIO`. This was failing sometimes. Frankly, I'm not sure why it ever worked. Maybe it works on some versions of Python but not others? I dunno. But this fixes it everywhere and is clearly correct. Signed-off-by: Larry Gritz <lg@larrygritz.com> Signed-off-by: Peter Kovář <peter.kovar@reflexion.tv>
We did
import OpenImageIO as oiiothen instead of usingoiio, we usedOpenImageIO.This was failing sometimes. Frankly, I'm not sure why it ever worked.
Maybe it works on some versions of Python but not others?
I dunno. But this fixes it everywhere and is clearly correct.