EDK II Python development process specification -draft

EDK II Python development process specification -draft

[Purma, Kondal R]

[-- Attachment #1: Type: text/plain, Size: 689 bytes --]

Hi,

The draft specification for EDK II Python development process for presentation made earlier now available .

Presentation thread :

https://edk2.groups.io/g/announce/message/92

Wiki Page link for specification document:

https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Draft-Specification

GitBook link for specification document:

https://edk2-docs.gitbooks.io/edk-ii-python-development-process-speicfication

PDF version can be downloaded from:

https://legacy.gitbook.com/download/pdf/book/edk2-docs/edk-ii-python-development-process-speicfication

Draft version available for 2 week review period and seeking for feedback.

Thanks,

Kondal.

[-- Attachment #2: Type: text/html, Size: 1947 bytes --]

Re: [edk2-devel] EDK II Python development process specification -draft

[Sean]

[-- Attachment #1: Type: text/plain, Size: 998 bytes --]

This looks fine but it seems focused on writing a new module/project.  Most python work going into edk2 is part of existing code.
I would like to see additional documentation about how this applies to edk2 basetools.

* A flake8 config file could be added to basetools python.
* Documentation of developer workflows with edk2 basetools
* A plan for how to get edk2 basetools to meet these requirements
* A plan for automated patch verification of meeting these rules.

I have a rule of thumb for code guidelines.  I don't make any rules unless I can enforce them without un-manageable burden.

I also would rather see this type of documentation in the basetools python folder.  There is no reason a developer should have to go looking for this somewhere else within the tianocore site.

Finally, I would suggest we leverage an auto-formatter and provide the config file for that.  This reduces significant burden on the developer and keeps all contributes aligned.

Thanks
Sean

[-- Attachment #2: Type: text/html, Size: 1124 bytes --]

Re: [edk2-devel] EDK II Python development process specification -draft

[Purma, Kondal R]

[-- Attachment #1: Type: text/plain, Size: 627 bytes --]

Thanks for feedback an your are exactly right. This applies for new module/project and every point you mentioned is valid.

We should also make sure these rules applies to bug fixes, or code adding as feature in existing files.

I raised all these question my self and taken initial step.

As a first step,  developed wrapper tool (POC) to apply flake8 on patches only which we can immediately adopt to Basetools etc..

Along with the POC tool(if possible we can make as flake8 plugin) , I will come up with presentation to address all our concerns. We can review and finalize the best practices.

Thanks,
Kondal.

[-- Attachment #2: Type: text/html, Size: 675 bytes --]

Re: [edk2-devel] EDK II Python development process specification -draft

[Rebecca Cran]

[-- Attachment #1: Type: text/plain, Size: 1051 bytes --]

I just noticed a typo on the page about python tools: the heading says Falke8 instead of Flake8.

— 
Rebecca Cran

>> On Mar 6, 2020, at 5:27 PM, Purma, Kondal R <kondal.r.purma@intel.com> wrote:
> 
> Hi,
> 
>  The draft specification for EDK II Python development process for presentation made earlier now available .
> 
>
> 
>  Presentation thread :
> 
>
> 
>   https://edk2.groups.io/g/announce/message/92
> 
> 
>
> 
>  Wiki Page link for specification document:
> 
>
> 
>  https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Draft-Specification
> 
>
> 
>
> 
> GitBook link for specification document:
> 
> https://edk2-docs.gitbooks.io/edk-ii-python-development-process-speicfication
> 
>
> 
> PDF version can be downloaded from:
> 
>  https://legacy.gitbook.com/download/pdf/book/edk2-docs/edk-ii-python-development-process-speicfication
> 
>
> 
>
> 
> Draft version available for 2 week review period and seeking for feedback.
> 
>
> 
> Thanks,
> 
> Kondal.
> 
>
> 
> 


[-- Attachment #2: Type: text/html, Size: 2550 bytes --]

Re: [edk2-devel] EDK II Python development process specification -draft

[Purma, Kondal R]

[-- Attachment #1: Type: text/plain, Size: 1313 bytes --]

Thank you so much Rebecca. Will fix it.

--Kondal.

From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Rebecca Cran
Sent: Tuesday, March 10, 2020 1:06 PM
To: devel@edk2.groups.io; Purma, Kondal R <kondal.r.purma@intel.com>
Subject: Re: [edk2-devel] EDK II Python development process specification -draft

I just noticed a typo on the page about python tools: the heading says Falke8 instead of Flake8.
—
Rebecca Cran


On Mar 6, 2020, at 5:27 PM, Purma, Kondal R <kondal.r.purma@intel.com<mailto:kondal.r.purma@intel.com>> wrote:


Hi,

 The draft specification for EDK II Python development process for presentation made earlier now available .



 Presentation thread :



  https://edk2.groups.io/g/announce/message/92



 Wiki Page link for specification document:



 https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Draft-Specification





GitBook link for specification document:

https://edk2-docs.gitbooks.io/edk-ii-python-development-process-speicfication



PDF version can be downloaded from:

 https://legacy.gitbook.com/download/pdf/book/edk2-docs/edk-ii-python-development-process-speicfication





Draft version available for 2 week review period and seeking for feedback.



Thanks,

Kondal.





[-- Attachment #2: Type: text/html, Size: 6340 bytes --]

Re: [edk2-devel] EDK II Python development process specification -draft

[Purma, Kondal R]

[-- Attachment #1: Type: text/plain, Size: 281 bytes --]

Thanks for feedback so far. Reminder to get more valuable feedback if any, to address before enforcing this spec next week.
Plan is to make  initial version of spec along with other specifications and start working on Sean feedback and how to start enforcing the specification.

[-- Attachment #2: Type: text/html, Size: 295 bytes --]

Re: [edk2-devel] EDK II Python development process specification -draft

[Bob Feng]

[-- Attachment #1: Type: text/plain, Size: 607 bytes --]

Hi Kondal ,

I agree the coding guidelines and tools can help improve the python code quality, but I think these guidelines in this spec are too general for BaseTools. Besides the coding style,  BaseTools has many specific code issues, such as the high coupling between modules, not clear module interface, big function with hundreds lines, abused global variables. I hope there could be a python code design guidelines, for example, how to apply the software design principle or the software design pattern in the Basetools development process.

I think this spec itself looks good.

Thanks,
Bob

[-- Attachment #2: Type: text/html, Size: 643 bytes --]

Re: [edk2-devel] EDK II Python development process specification -draft

[Purma, Kondal R]

[-- Attachment #1: Type: text/plain, Size: 225 bytes --]

Thanks for the feedback and your view points Bob. I totally agree on your points and the  base tools issues.
I think together we can fix the issues you mentioned and apply best software design principles to  base tools .

[-- Attachment #2: Type: text/html, Size: 238 bytes --]

Re: [edk2-devel] EDK II Python development process specification -draft

[Purma, Kondal R]

[-- Attachment #1: Type: text/plain, Size: 220 bytes --]

Thanks for all feedback received so far. As the review and feedback period is over, moving forward to fix the bugs and announce first official release of EDK II Python Development Process specification.
Thank you all.

[-- Attachment #2: Type: text/html, Size: 224 bytes --]