pyopengl icon indicating copy to clipboard operation
pyopengl copied to clipboard

Upstream has renamed parameters (and we should have a procedure for that)

Open mcfletch opened this issue 5 years ago • 1 comments

In this commit by @pdaniell-nv for KhronosGroup/OpenGL-Registry#285 the OpenGL API is updated to change parameter names for 14 entry points.

commit 37add60a829ac4b184089d982e4292a4044e2ca4
Author: Piers Daniell <[email protected]>
Date:   Wed Oct 30 10:22:44 2019 -0600

    Rename bufSize to count where necessary (#285)

    * Rename bufSize to count where necessary

    Also rename bufsize to bufSize.

    * Rebase

There are some issues that arise:

  • our wrappers are based on parameter names (not indices) and
  • here, the changed parameter names refer to parameters likely to be referenced in wrapper operations (e.g. wrappers that get bufSize by introspecting passed in numpy arrays)
  • python users who happen to be using the parameter names in a call will have their code fail on upgrade

The first two mean I'll need to go through and review those wrappers to be sure we don't reference the old names. That's not a big deal, there might be a few dozen lines of code affected.

The third has likely happened lots of times without being noticed, as I've not, in the past, remarked on parameter-name changes and users likely have just hit the change, looked at the updated API docs and made a change without complaining to me. Likely I need to make our auto-generated wrapping a bit smarter so that it flags such changes in the APIs and tells me we need to increment our external versions and create release notes about the changes.

mcfletch avatar Feb 02 '20 15:02 mcfletch

Is it possible for named parameters wrappers to support both the old and new name?

pdaniell-nv avatar Feb 04 '20 17:02 pdaniell-nv