bfueldner / pysvd Goto Github PK

Add package documentation for all SVD elements and the add a starting point for new projects.

Hello, thanks for the useful library.
I have been playing around with it in the terminal and I have suggestions for making it more user-friendly.

• provide some form of top-level entry point so we don't have to rely on doing the xml parsing separately to then pass a node to the Device constructor, e.g. a parse_sdv_file(file_path) function.
• populating __str__ and __repr__ with self.name would make the console experience much better.
  At the moment when printing peripherals or registersI am seeing:

dev.peripherals
Out[27]:
[<pysvd.element.Peripheral at 0x2118e537af0>,
 <pysvd.element.Peripheral at 0x2118e537a90>,
 <pysvd.element.Peripheral at 0x2118cabc4f0>,
...]
 p.registers
Out[32]:
[<pysvd.element.Register at 0x2118e379c70>,
 <pysvd.element.Register at 0x2118e379040>,
 <pysvd.element.Register at 0x21191b6dca0>,
...]

Would be much nicer to see:

[DCMI,
 FMC,
 DBG,
 DMA2,
 DMA1,
 RCC,
 GPIOH,
 GPIOG,
 GPIOF,
...]

etc.
I can see most of the classes derivatives have a 'name' member (some don't though), we could discuss what the best approach is if you are open to it.