Skip to content

Python: add type annotations to all examples and documentation #4752

Open
@lgritz

Description

@lgritz

Our minimum supported python version is 3.7 currently (soon to be 3.9, I suspect). Python 2.x is long gone for us, but lots of our python examples still haven't embraced the new syntax with type annotations that has been available since python 3.5.

There is PR #4692 in progress now to add stub files, and in the process, adds type annotations to most of the testsuite python-*/src/test_*.py files.

But that still leaves:

  • All inline python examples in the docs themselves src/doc/*.md (note: rendered docs at https://docs.openimageio.org)
  • The documentation examples that have been converted into tests and incorporated into docs by reference: testsuite/docs-examples-python/src/docs-examples-*.py
  • Any other auxiliary scripts that we have, such as testsuite/runtest.py

This would be a great Dev Days project! (Especially for somebody who wants to do something for OIIO but knows more Python than C++ and maybe didn't think they had as much to offer.) I don't think any one person needs to do it ALL, this could be the project of multiple people, as long as you divide up the work -- each person can claim a few particular files, or a particular chapter of the docs, and just do that while others pick different non-conflicting parts.

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood one-day project for beginners without much knowledge of the code base.help wantedA task that is desired, but needs somebody to commit the effort to implement it.pythonPython APIs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions