Page 1 of 1
extmod generator
Posted: Thu Mar 03, 2016 4:20 pm
by stick
Recently I was trying to learn how to write my own external modules and found out it was not completely straightforward.
To help me out, I wrote a generator that will analyze a module written in Python3 syntax and generate a module to use with Micropython (to be placed in extmod directory).
Source is available here:
https://github.com/prusnak/micropython-extmod-generator
It has some rough edges, but I think it is already quite usable and helpful.
What do you think? As always, pull requests are welcome!
Re: extmod generator
Posted: Thu Mar 03, 2016 6:39 pm
by pohmelie
Nice idea. I think example.py and example.c should be in readme.
Re: extmod generator
Posted: Thu Mar 03, 2016 10:36 pm
by stick
Added links to examples to README.md
Re: extmod generator
Posted: Thu Mar 03, 2016 11:19 pm
by SpotlightKid
Cool, very useful. Two suggestions:
- I think the convention in Python is generally to use __author__ instead of _author (and __version__, etc.) for module meta data.
- Would be nice to generate the qstr definitions as well (maybe put them in a comment in the .c file).
Re: extmod generator
Posted: Thu Mar 03, 2016 11:36 pm
by stick
SpotlightKid wrote:
- I think the convention in Python is generally to use __author__ instead of _author (and __version__, etc.) for module meta data.
OK, changed in 409337515c0db6789a8344164102955b7ce0ce96.
SpotlightKid wrote:
- Would be nice to generate the qstr definitions as well (maybe put them in a comment in the .c file).
Aren't they supposed to be generated automagically via makeqstrdata.py during the build?
Re: extmod generator
Posted: Thu Mar 03, 2016 11:43 pm
by dhylands
stick wrote:Aren't they supposed to be generated automagically via makeqstrdata.py during the build?
No makeqstrdata takes the qstrs found in one of the qstrdefs.h files and generates the c structures associated with a qstr.
The file you'd need to create would be a file that contained the:
in it. The developer would then need to merge this with
https://github.com/micropython/micropyt ... #L665-L671 (I highlighted the ubinascii qstr's).
I'd love to see a tool which created the qstrdefs.h file automagically, but it hasn't been written yet. Getting it right is definitely non-trivial.
Re: extmod generator
Posted: Fri Mar 04, 2016 12:09 am
by stick
dhylands wrote:No makeqstrdata takes the qstrs found in one of the qstrdefs.h files and generates the c structures associated with a qstr.
Ah I see, implemented in 53ff05cd419ea37b128807effe833b480845fbaf
dhylands wrote:
I'd love to see a tool which created the qstrdefs.h file automagically, but it hasn't been written yet. Getting it right is definitely non-trivial.
Hm, I think that similar magic to what I used in the commit above could be used to generate all required qstrdefs.
Re: extmod generator
Posted: Fri Mar 04, 2016 12:28 am
by dhylands
The issue I see with generating qstrdefs automtically is figuring out what #ifdefs they belong in. We don't want to include unnecessary qstrs in the image.
Re: extmod generator
Posted: Mon Mar 07, 2016 7:25 am
by braiins
qstr generation is something that should definitely be looked into. I believe the point is to not bloat sources with #ifdefs or even better to ban the use of ifdefs except for header file guards
Stick is in much better position while generating qstr definitions since with python reflection the generator know exactly what comes into the output. However, this is not the case with hand written uPy module in C
Re: extmod generator
Posted: Mon Mar 07, 2016 12:36 pm
by stick
dhylands wrote:The issue I see with generating qstrdefs automtically is figuring out what #ifdefs they belong in. We don't want to include unnecessary qstrs in the image.
I created a spin-off thread for this topic here:
qstrdef-generator