La API de NVDA debe mantener la compatibilidad con los complementos a lo largo de los ciclos de desarrollo anuales.
La primera versión de cada año, la 20XX.1, es cuando la API de NVDA puede introducir cambios disruptivos.
Para mejorar la API de NVDA, se pueden implementar cambios que romperán la compatibilidad futura, mientras retengan la compatibilidad hacia atrás hasta la versión 20XX.1.
Esto se puede hacer empleando una comprobación de versión para automatizar la obsolescencia. Por ejemplo, si quisieras reemplazar los usos de foo por var. Cuando empezamos a trabajar en NEXT_YEAR, foo ya no formará parte de la API de NVDA y se deben eliminar todos los usos internos antes.
from buildVersion import version_year
if version_year < NEXT_YEAR:
foo = bar
Para asegurar que un módulo mantiene importables los mismos nombres de símbolos, comprueba a través de las versiones qué se importa usando la consola Python de NVDA.
import controlTypes
dir(controlTypes)
Los cambios que vayan más allá de renombrar o eliminar símbolos deben tratarse con cuidado mediante un enfoque diferente.
Cualquier cambio que rompa la API, como obsolescencias marcadas para su eliminación, debería comentarse junto con el año en que se pretende eliminar, y notas sobre cómo implementar el cambio de API como desarrollador de complementos y desarrollador de NVDA.