Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
I have placed the KiCad Python Style Guide in https://github.com/HiGregSmith/kicad-python-style-guidefor comment. It is not formatted particularly well, but captures everything mentioned in this thread. I thought it was important to include the "Logistics" section because that is hard to find otherwise. I do think this should be merged into the Development Pcbnew Plugins document after it's honed and polished:http://docs.kicad-pcb.org/doxygen/md_Documentation_development_pcbnew-plugins.html I also think the "Resources" section is important at the top in bullet format instead of in a narrative. The links are less difficult to overlook, IMHO. Taking comments on content at the moment. On Monday, August 14, 2017 7:55 AM, Wayne Stambaugh wrote: On 8/12/2017 11:59 AM, Greg Smith wrote: > Where should I submit a (likely short) style guide for review? The KiCad developer's mailing list. > > I have recently reviewed PEP8 and updated the code for KiPadCheck and > LayerViewSet to be compliant, so I can write a short document about the KiCad > Python style for others to review. Our developer docs are written using Doxygen's markdown format. Once you have you initial draft, please submit it to this mailing list for review. Once we have it finalized, it can be merged into the master branch. Thank you taking on this task. It's one of those things we knew we would have to address at some point. > > There are other guides similar to style guides that might be relevant as well. > > PEP8 is great, and it already allows the main exception KiCad will probably > need to specify: case of function names. PEP8 primarily suggests > lower_case_with_underscore_separators, yet many of KiCad python methods seems > to be specified as CamelCase. This is most likely because our C++ source policy is CamelCase or lower_case_with_underscore_separators. The same policy seems reasonable for the kicad python code as well. > > PEP8 essentially recommends "do this [specific thing], unless you need to do > something else for consistency". > > Greg S. > >> On Aug 12, 2017, at 10:43 AM, Adam Wolf >> wrote: >> >> I think PEP8 is great for us. Let's just add a line that says "We use >> PEP8 as our Python style guide." >> >> Adam Wolf >> >>> On Sat, Aug 12, 2017 at 10:27 AM, Strontium wrote: >>> Hello Wayne and Greg, >>> >>> Can I suggest just adopting PEP8 for Python code formatting. Its clean, >>> well documented, and there are plenty of linters to check conformance. And >>> if there is anything in PEP8 that is annoying for KiCad development (cant >>> imagine what) just specify an exclusion or exception. >>> >>> Steven >>> On 12/08/17 22:15, Wayne Stambaugh wrote: On 8/11/2017 10:08 PM, Greg Smith wrote: >>> >>> ... > > Suggestions on coding style, functionality, integration technique are > welcome! We have not defined a Python coding style. It's something that needs to be done but no one has had the time to do it. Please look at some of the existing Python code in the KiCad source repo and follow what others have done. The last time I looked (which admittedly has been a while), the formatting of our Python code was pretty consistent. >>> >>> ... >>> >>> >>> >>> ___ >>> Mailing list: https://launchpad.net/~kicad-developers >>> Post to : kicad-developers@lists.launchpad.net >>> Unsubscribe : https://launchpad.net/~kicad-developers >>> More help : https://help.launchpad.net/ListHelp >> >> ___ >> Mailing list: https://launchpad.net/~kicad-developers >> Post to : kicad-developers@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~kicad-developers >> More help : https://help.launchpad.net/ListHelp > > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
On 8/12/2017 11:59 AM, Greg Smith wrote: > Where should I submit a (likely short) style guide for review? The KiCad developer's mailing list. > > I have recently reviewed PEP8 and updated the code for KiPadCheck and > LayerViewSet to be compliant, so I can write a short document about the KiCad > Python style for others to review. Our developer docs are written using Doxygen's markdown format. Once you have you initial draft, please submit it to this mailing list for review. Once we have it finalized, it can be merged into the master branch. Thank you taking on this task. It's one of those things we knew we would have to address at some point. > > There are other guides similar to style guides that might be relevant as well. > > PEP8 is great, and it already allows the main exception KiCad will probably > need to specify: case of function names. PEP8 primarily suggests > lower_case_with_underscore_separators, yet many of KiCad python methods seems > to be specified as CamelCase. This is most likely because our C++ source policy is CamelCase or lower_case_with_underscore_separators. The same policy seems reasonable for the kicad python code as well. > > PEP8 essentially recommends "do this [specific thing], unless you need to do > something else for consistency". > > Greg S. > >> On Aug 12, 2017, at 10:43 AM, Adam Wolf >> wrote: >> >> I think PEP8 is great for us. Let's just add a line that says "We use >> PEP8 as our Python style guide." >> >> Adam Wolf >> >>> On Sat, Aug 12, 2017 at 10:27 AM, Strontium wrote: >>> Hello Wayne and Greg, >>> >>> Can I suggest just adopting PEP8 for Python code formatting. Its clean, >>> well documented, and there are plenty of linters to check conformance. And >>> if there is anything in PEP8 that is annoying for KiCad development (cant >>> imagine what) just specify an exclusion or exception. >>> >>> Steven >>> On 12/08/17 22:15, Wayne Stambaugh wrote: On 8/11/2017 10:08 PM, Greg Smith wrote: >>> >>> ... > > Suggestions on coding style, functionality, integration technique are > welcome! We have not defined a Python coding style. It's something that needs to be done but no one has had the time to do it. Please look at some of the existing Python code in the KiCad source repo and follow what others have done. The last time I looked (which admittedly has been a while), the formatting of our Python code was pretty consistent. >>> >>> ... >>> >>> >>> >>> ___ >>> Mailing list: https://launchpad.net/~kicad-developers >>> Post to : kicad-developers@lists.launchpad.net >>> Unsubscribe : https://launchpad.net/~kicad-developers >>> More help : https://help.launchpad.net/ListHelp >> >> ___ >> Mailing list: https://launchpad.net/~kicad-developers >> Post to : kicad-developers@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~kicad-developers >> More help : https://help.launchpad.net/ListHelp > > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
On 8/12/2017 1:05 PM, Simon Küppers wrote: > I wrote a developer Documentation Page on Python scripting for kicad, i > think the information is best written down there. I have no objections to this. I could just as easily be added to the coding policy in a separate section for Python scripting. > > Am 12. August 2017 18:42:05 MESZ schrieb Adam Wolf > : > > Sure. I was actually in the audience for that talk :) IIRC, the > biggest takeaway is that sometimes there are exceptions, especially > for highly idiomatic code, and also that the 80 character original > line length limit is silly today and something like 120 is more > appropriate. > > If you have particular changes you'd like to suggest to PEP8 for > Python style, let's discuss them. On the other hand, we have no > automatic code rejection because of style--it's all human enforced at > this point, which means those exceptions for highly idiomatic code, > when commented and explained to the committer, already get through. > > Adam Wolf > > On Sat, Aug 12, 2017 at 11:30 AM, Kevin Cozens wrote: > > On 2017-08-12 11:43 AM, Adam Wolf wrote: > > > I think PEP8 is great for us. Let's just add a line that > says "We use > PEP8 as our Python style guide." > > > > Before you get too deep in to following PEP8 you might want to > watch the > video of a talk given by Raymond Hettinger (a core Python > programmer) at > PyCon 2015. The talk is called Beyond "PEP 8 -- Best practices > for beautiful > intelligible code" and can be seen at: > https://www.youtube.com/watch?v=wf-BqAjZb8M > > -- > Cheers! > > Kevin. > > http://www.ve3syb.ca/ |"Nerds make the shiny things that distract > Owner of Elecraft K2 #2172 | the mouth-breathers, and that's why > we're > | powerful!" > #include | --Chris Hardwick > > > > > > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > > > > > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > > > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
I'm OK with pep8 or some variation there of. On 8/12/2017 12:42 PM, Adam Wolf wrote: > Sure. I was actually in the audience for that talk :) IIRC, the > biggest takeaway is that sometimes there are exceptions, especially > for highly idiomatic code, and also that the 80 character original > line length limit is silly today and something like 120 is more > appropriate. Our C++ coding policy is 100 characters so for the sake of consistency we should probably do the same for Python source files. > > If you have particular changes you'd like to suggest to PEP8 for > Python style, let's discuss them. On the other hand, we have no > automatic code rejection because of style--it's all human enforced at > this point, which means those exceptions for highly idiomatic code, > when commented and explained to the committer, already get through. > > Adam Wolf > > On Sat, Aug 12, 2017 at 11:30 AM, Kevin Cozens wrote: >> On 2017-08-12 11:43 AM, Adam Wolf wrote: >>> >>> I think PEP8 is great for us. Let's just add a line that says "We use >>> PEP8 as our Python style guide." >> >> >> Before you get too deep in to following PEP8 you might want to watch the >> video of a talk given by Raymond Hettinger (a core Python programmer) at >> PyCon 2015. The talk is called Beyond "PEP 8 -- Best practices for beautiful >> intelligible code" and can be seen at: >> https://www.youtube.com/watch?v=wf-BqAjZb8M >> >> -- >> Cheers! >> >> Kevin. >> >> http://www.ve3syb.ca/ |"Nerds make the shiny things that distract >> Owner of Elecraft K2 #2172 | the mouth-breathers, and that's why we're >> | powerful!" >> #include | --Chris Hardwick >> >> >> ___ >> Mailing list: https://launchpad.net/~kicad-developers >> Post to : kicad-developers@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~kicad-developers >> More help : https://help.launchpad.net/ListHelp > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
I wrote a developer Documentation Page on Python scripting for kicad, i think the information is best written down there. Am 12. August 2017 18:42:05 MESZ schrieb Adam Wolf : >Sure. I was actually in the audience for that talk :) IIRC, the >biggest takeaway is that sometimes there are exceptions, especially >for highly idiomatic code, and also that the 80 character original >line length limit is silly today and something like 120 is more >appropriate. > >If you have particular changes you'd like to suggest to PEP8 for >Python style, let's discuss them. On the other hand, we have no >automatic code rejection because of style--it's all human enforced at >this point, which means those exceptions for highly idiomatic code, >when commented and explained to the committer, already get through. > >Adam Wolf > >On Sat, Aug 12, 2017 at 11:30 AM, Kevin Cozens wrote: >> On 2017-08-12 11:43 AM, Adam Wolf wrote: >>> >>> I think PEP8 is great for us. Let's just add a line that says "We >use >>> PEP8 as our Python style guide." >> >> >> Before you get too deep in to following PEP8 you might want to watch >the >> video of a talk given by Raymond Hettinger (a core Python programmer) >at >> PyCon 2015. The talk is called Beyond "PEP 8 -- Best practices for >beautiful >> intelligible code" and can be seen at: >> https://www.youtube.com/watch?v=wf-BqAjZb8M >> >> -- >> Cheers! >> >> Kevin. >> >> http://www.ve3syb.ca/ |"Nerds make the shiny things that >distract >> Owner of Elecraft K2 #2172 | the mouth-breathers, and that's why >we're >> | powerful!" >> #include | --Chris Hardwick >> >> >> ___ >> Mailing list: https://launchpad.net/~kicad-developers >> Post to : kicad-developers@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~kicad-developers >> More help : https://help.launchpad.net/ListHelp > >___ >Mailing list: https://launchpad.net/~kicad-developers >Post to : kicad-developers@lists.launchpad.net >Unsubscribe : https://launchpad.net/~kicad-developers >More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
Sure. I was actually in the audience for that talk :) IIRC, the biggest takeaway is that sometimes there are exceptions, especially for highly idiomatic code, and also that the 80 character original line length limit is silly today and something like 120 is more appropriate. If you have particular changes you'd like to suggest to PEP8 for Python style, let's discuss them. On the other hand, we have no automatic code rejection because of style--it's all human enforced at this point, which means those exceptions for highly idiomatic code, when commented and explained to the committer, already get through. Adam Wolf On Sat, Aug 12, 2017 at 11:30 AM, Kevin Cozens wrote: > On 2017-08-12 11:43 AM, Adam Wolf wrote: >> >> I think PEP8 is great for us. Let's just add a line that says "We use >> PEP8 as our Python style guide." > > > Before you get too deep in to following PEP8 you might want to watch the > video of a talk given by Raymond Hettinger (a core Python programmer) at > PyCon 2015. The talk is called Beyond "PEP 8 -- Best practices for beautiful > intelligible code" and can be seen at: > https://www.youtube.com/watch?v=wf-BqAjZb8M > > -- > Cheers! > > Kevin. > > http://www.ve3syb.ca/ |"Nerds make the shiny things that distract > Owner of Elecraft K2 #2172 | the mouth-breathers, and that's why we're > | powerful!" > #include | --Chris Hardwick > > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
On 2017-08-12 11:43 AM, Adam Wolf wrote: I think PEP8 is great for us. Let's just add a line that says "We use PEP8 as our Python style guide." Before you get too deep in to following PEP8 you might want to watch the video of a talk given by Raymond Hettinger (a core Python programmer) at PyCon 2015. The talk is called Beyond "PEP 8 -- Best practices for beautiful intelligible code" and can be seen at: https://www.youtube.com/watch?v=wf-BqAjZb8M -- Cheers! Kevin. http://www.ve3syb.ca/ |"Nerds make the shiny things that distract Owner of Elecraft K2 #2172 | the mouth-breathers, and that's why we're | powerful!" #include | --Chris Hardwick ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
Where should I submit a (likely short) style guide for review? I have recently reviewed PEP8 and updated the code for KiPadCheck and LayerViewSet to be compliant, so I can write a short document about the KiCad Python style for others to review. There are other guides similar to style guides that might be relevant as well. PEP8 is great, and it already allows the main exception KiCad will probably need to specify: case of function names. PEP8 primarily suggests lower_case_with_underscore_separators, yet many of KiCad python methods seems to be specified as CamelCase. PEP8 essentially recommends "do this [specific thing], unless you need to do something else for consistency". Greg S. > On Aug 12, 2017, at 10:43 AM, Adam Wolf wrote: > > I think PEP8 is great for us. Let's just add a line that says "We use > PEP8 as our Python style guide." > > Adam Wolf > >> On Sat, Aug 12, 2017 at 10:27 AM, Strontium wrote: >> Hello Wayne and Greg, >> >> Can I suggest just adopting PEP8 for Python code formatting. Its clean, >> well documented, and there are plenty of linters to check conformance. And >> if there is anything in PEP8 that is annoying for KiCad development (cant >> imagine what) just specify an exclusion or exception. >> >> Steven >> >>> On 12/08/17 22:15, Wayne Stambaugh wrote: >>> >>> On 8/11/2017 10:08 PM, Greg Smith wrote: >> >> ... Suggestions on coding style, functionality, integration technique are welcome! >>> >>> We have not defined a Python coding style. It's something that needs to >>> be done but no one has had the time to do it. Please look at some of >>> the existing Python code in the KiCad source repo and follow what others >>> have done. The last time I looked (which admittedly has been a while), >>> the formatting of our Python code was pretty consistent. >> >> ... >> >> >> >> ___ >> Mailing list: https://launchpad.net/~kicad-developers >> Post to : kicad-developers@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~kicad-developers >> More help : https://help.launchpad.net/ListHelp > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
I think PEP8 is great for us. Let's just add a line that says "We use PEP8 as our Python style guide." Adam Wolf On Sat, Aug 12, 2017 at 10:27 AM, Strontium wrote: > Hello Wayne and Greg, > > Can I suggest just adopting PEP8 for Python code formatting. Its clean, > well documented, and there are plenty of linters to check conformance. And > if there is anything in PEP8 that is annoying for KiCad development (cant > imagine what) just specify an exclusion or exception. > > Steven > > On 12/08/17 22:15, Wayne Stambaugh wrote: >> >> On 8/11/2017 10:08 PM, Greg Smith wrote: > > ... >>> >>> Suggestions on coding style, functionality, integration technique are >>> welcome! >> >> We have not defined a Python coding style. It's something that needs to >> be done but no one has had the time to do it. Please look at some of >> the existing Python code in the KiCad source repo and follow what others >> have done. The last time I looked (which admittedly has been a while), >> the formatting of our Python code was pretty consistent. > > ... > > > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
Hello Wayne and Greg, Can I suggest just adopting PEP8 for Python code formatting. Its clean, well documented, and there are plenty of linters to check conformance. And if there is anything in PEP8 that is annoying for KiCad development (cant imagine what) just specify an exclusion or exception. Steven On 12/08/17 22:15, Wayne Stambaugh wrote: On 8/11/2017 10:08 PM, Greg Smith wrote: ... Suggestions on coding style, functionality, integration technique are welcome! We have not defined a Python coding style. It's something that needs to be done but no one has had the time to do it. Please look at some of the existing Python code in the KiCad source repo and follow what others have done. The last time I looked (which admittedly has been a while), the formatting of our Python code was pretty consistent. ... ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Python script offered as example for Action Plugin and wxFormBuilder integration
On 8/11/2017 10:08 PM, Greg Smith wrote: > What is the process of getting a python example script into KiCad > distribution? You must submit a patch (preferably using `git format-patch` against the HEAD of the KiCad master branch) to the developer's mailing list so developers can test and comment on it. Once it has been approved, it can be merged into the master branch. It may take some time and several iterations to get the approval of the lead developers so please be patient. > > What is the recommended copyright notice that I should place at the top > of the file? There is a copyright.h file in the root folder of the KiCad source repo. It's commented for C++ but it should be trivial to convert it over to the Python commenting style. > > Suggestions on coding style, functionality, integration technique are > welcome! We have not defined a Python coding style. It's something that needs to be done but no one has had the time to do it. Please look at some of the existing Python code in the KiCad source repo and follow what others have done. The last time I looked (which admittedly has been a while), the formatting of our Python code was pretty consistent. > > This python script is usable example of how to integrate a gui built > with wxFormBuilder and > implementing Action Plugin feature provided in KiCad. It has been tested > with recent nightly KiCad build (Windows 7). I didn't see the wxFormBuild file (.fpb) in your repo. We include those in our source so other users can modify them and regenerate the dialog source code. Typically we add them to a separate dialogs/ folder in our source to keep them separated from the wxFormBuilder source code but doing so will require changing you Python scripts so the Python source files generated by wxFormbuilder can be loaded. There has been discussion about dumping wxFormBuilder at some point due to it's spotty maintenance and poor code reuse which is something I support so I cannot say how much of a future something like this will have. > > It is a short functional example 187 lines long (at the moment) adding > (IMHO) much needed functionality to KiCad pcbnew. Thank you for your interest in contributing to KiCad. Cheers, Wayne > > The github repository is here: > https://github.com/HiGregSmith/LayerViewSet > > And the KiCad Forums thread is here: > https://forum.kicad.info/t/announcing-layerviewset-a-python-script-for-manipulating-visible-layers/7400 > > > > > > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
