-----Original Message-----
From: Feng, Bob C <bob.c.feng@...>
Sent: Friday, September 20, 2019 10:19 PM
To: Ni, Ray <ray.ni@...>; announce@edk2.groups.io
Cc: Purma, Kondal R <kondal.r.purma@...>; Sean Brogan <sean.brogan@...>; Kinney, Michael D
<michael.d.kinney@...>
Subject: RE: TianoCore Community Design Meeting Minutes - Sep 19

Ray,

I remember we also discuss the type hints in Python, adding the data type for function's parameter and return value.

I think mypy is most common tool for doing type checking.

Thanks,
Bob

-----Original Message-----
From: announce@edk2.groups.io <announce@edk2.groups.io> On Behalf Of Ni, Ray
Sent: Saturday, September 21, 2019 2:49 AM
To: announce@edk2.groups.io
Cc: Purma, Kondal R <kondal.r.purma@...>; Sean Brogan <sean.brogan@...>; Kinney, Michael D
<michael.d.kinney@...>
Subject: [edk2-announce] TianoCore Community Design Meeting Minutes - Sep 19

(Kondal, Sean, Mike, could you please reply to correct the minutes if there is something wrong or not captured?) 1. Python
Development Process (Intel)
Presenter: Kondal Purma
Slides: https://edk2.groups.io/g/devel/files/Designs/2019/0919/PythonDevelopmentProcess-OpenSource.pdf

* Problem
Page #2: Gap in predefined consistent code style and toolset for python development flow.

* Proposal: Python development process flow chart Page #4 Code style: PEP 8
Docstring: PEP 257
Code checker: flake8
Page #6, #7 for detailed flake8 config Docstring checker: flake8-docstrings
unittest: python unittest library
code complexity measure:
https://github.com/PyCQA/mccabe
https://en.wikipedia.org/wiki/Cyclomatic_complexity

* Opens
@Sean: Why use unittest library, not pytest?
@Kondal: Agree to use pytest.

@Sean: Suggest using strict python types to avoid potential bugs in code

@Sean: Will the python coding style checking included in CI server?
@Mike: Finalize the requirement of python coding style first so developers have the chance to run it locally before sending
code review. Agree to have the server to run check automatically.

@Sean: Base tool python code is not package organized, difficult to run the unit test or reuse the code.

@Mike: There will be 10-20 pages of gitbook in markdown format to document the requirement of python code.

@Sean: File/folder name/case don't follow PEP8. flake8 doesn't test that, need the standard of file/folder name.

@Liming: What will be included in the final document?
@Mike: Generally, about how to write good python code.

@Sean: Can leverage pytools

@Mike: Will have small group discussion and come out with the proposal draft

Thanks,
Ray

On Sep 24, 2019, at 12:41 AM, Purma, Kondal R <kondal.r.purma@...> wrote:


Rebecca,

Pylama definitely a good implementation available in python world and additionally it also does java script checking(which is not applicable to EDK2), however I feel flake8 might be suitable enough for EDKII or build related tools environment.

I feel falke8 is right choice because we can develop plugin for typical use cases only applicable to firmware development .

We already using flake8 for “edk2-pytool-extensions”, so a common set of tools may be make more sense.

Appreciate your thoughts on this further .

Thanks,
Kondal.

From: Rebecca Cran <rebecca@...>
Sent: Friday, September 20, 2019 5:32 PM
To: Ni, Ray <ray.ni@...>; announce@edk2.groups.io
Cc: Purma, Kondal R <kondal.r.purma@...>; Sean Brogan <sean.brogan@...>; Kinney, Michael D <michael.d.kinney@...>
Subject: Re: [edk2-announce] TianoCore Community Design Meeting Minutes - Sep 19

On 2019-09-20 12:48, Ni, Ray wrote:

* Proposal: Python development process flow chart
Page #4
Code style: PEP 8
Docstring: PEP 257
Code checker: flake8
Page #6, #7 for detailed flake8 config
Docstring checker: flake8-docstrings
unittest: python unittest library
code complexity measure:
https://github.com/PyCQA/mccabe
https://en.wikipedia.org/wiki/Cyclomatic_complexity
Unfortunately I missed the meeting, but as I've said in the past on the devel mailing list, I'd suggest using pylama: https://github.com/klen/pylama

Code audit tool for Python and JavaScript. Pylama wraps these tools:

pycodestyle (formerly pep8) © 2012-2013, Florent Xicluna;
pydocstyle (formerly pep257 by Vladimir Keleshev) © 2014, Amir Rachum;
PyFlakes © 2005-2013, Kevin Watters;
Mccabe © Ned Batchelder;
Pylint © 2013, Logilab (should be installed 'pylama_pylint' module);
Radon © Michele Lacchia
gjslint © The Closure Linter Authors (should be installed 'pylama_gjslint' module);
eradicate © Steven Myint;
Mypy © Jukka Lehtosalo and contributors;


--
Rebecca Cran