← Back to team overview

kicad-developers team mailing list archive

Stable Release freeze & Python-API

 

I’ve been pushing a bit lately on the kicad-python Piers started,
trying to make everything as consistent as I can, documented [1],
and code as easy to type and tested as possible [2] [3] [4] [5].

My intention was to get this for the stable release, together with python,
but, given the close deadline, I’m unsure if it’s going to be better to merge it not
for this but for the next stable version.

One approach could be to do a quick review of the current API interface,
merge it now, and keep gradually merging back new objects exposed via the new
API (I could do the backports), and automated stable builds could help there,
the changes are quite orthogonal to the whole kicad code, so they may not
bring regressions.

My main concerns are nits:

1) Making parameters consistent across all the exposed functions.

   pos vs position, ref vs reference, etc...

2) Making parameter ordering consistent across exposed functions.

Opinions/Thoughts?


[1] http://ci.kicad-pcb.org/job/kicad-python/ws/doc/build/html/index.html
[2] https://github.com/KiCad/kicad-python/blob/master/tests/unit/pcbnew/test_pcbnew_board.py
[3] https://github.com/KiCad/kicad-python/blob/master/tests/unit/pcbnew/test_pcbnew_module.py
[4] https://github.com/KiCad/kicad-python/blob/master/tests/unit/pcbnew/test_pcbnew_drawing.py
[5] https://github.com/KiCad/kicad-python/blob/master/tests/unit/test_kicad_point.py

Miguel Ángel Ajo


Follow ups