Différences

Ci-dessous, les différences entre deux révisions de la page.

--- python [2016/12/29 16:29] – francois
+++ python [2019/09/10 14:52] (Version actuelle) – francois
@@ Ligne 1: / Ligne 1: @@
-==== Development Environment and librairies ====
+====== Development Environment and librairies ======
+===== Eclipse =====
+  * pydev
+  * mylin
-Please here after the typical list of addition apckage I'm using.
+===== Modules =====
-=== pip compliant ===
-* using pip : //py2exe//, pyqt5 , **pylint**, doxypypy, openpyxl , __rtcclient (optional)__
+Please here after the typical list of addition packages I'm using.\\
+Most of same are compliant with **pip** download installation mode:\\
+''pip install <package>'' or ''<installation directory>\python.exe -m pip install <package>''
-=== other installtion mode ====
+  * doxypypy : required for documentation generation
-== lxml ==
+  * **pylint**: required for code quality
-As on Windows pip lxml installation failed, download the package from [[http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml|Unofficial Windows binaries]] as described by [[http://lxml.de/installation.html|lxml.de official site]].\\
+  * openxl : MS Excel & Libreoffice calc files manipulation
+  * pyqt5 :
+  * __py2exe__
+  * __rtcclient__ : optional RTC management
+  * lxml (see below for installation)
+  * pywin32 (see below fo installation)
+  * unidecode (pylib)
-''C:\Apps\Python36>python.exe -m pip install <download path location>\lxml-3.7.1-cp36-cp36m-win_amd64.whl''\\
+=== lxml installation instructions ===
+As on Windows download pip lxml installation may failed, use the file pip installation mode:
+  * download the package from [[http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml|Unofficial Windows binaries]] as described by [[http://lxml.de/installation.html|lxml.de official site]].\\
+  * ''C:\Apps\Python36>python.exe -m pip install <download path location>\lxml-3.7.1-cp36-cp36m-win_amd64.whl''\\
-== pywin32 ==
+=== pywin32 installation instructions ===
-* use ''pypiwin32'' a pip complaint version of pywin32 (but at time I(m writing this lines only 2.19 is available)
+Three install solutions are availble:
-* donwload the installatble package
+  - use ''pypiwin32'' a pip compliant version of pywin32 but at time I'm writing this lines only the 2.19 is available where the official package is now available in version 2.20
-==== Fundamental Rules ====
+  - download the installation package from official site [[https://sourceforge.net/projects/pywin32/files/pywin32/Build%20220/ | direct access to build 220 files]]
+  - Install form source package
+= installation issue workaround =
+If the install package complains to not find any Python36 amd64 installation, try using the source package
-== RUL_GEN_001 Comments ==
+= installation from source package =
-A comment is there to explain the code not to rephrase it.\\
+  * Download the source package, unzip it
-Comment shall not contradict the code, update the comment with the code.
+  * Make sure to have latest visual studio SDK installed
+  * Open SDK command line (https://msdn.microsoft.com/en-us/library/x4d2c09s.aspx)
+    * Choose Start, expand All Programs, Visual Studio, Visual Studio Tools, and then choose a command prompt
+  * Make sure your python installation is in PATH \\ ''SET PATH=<python.exe directory path>;%PATH%''
+  * Run the following command from source directory:\\''C:\Apps\Python36\pywin32-220>python setup3.py -q install''
+  * If your experimented the following issue\\
+  > python setup3.pl install
+  Converting...
+  Executing...
+  Building pywin32 3.6.220.0
+  Traceback (most recent call last):
+  File "setup3.py", line 16, in <module>
+      exec(str(got))
+  File "<string>", line 1944, in <module>
+  File "<string>", line 594, in __init__
+  File "C:\Apps\Python36\lib\ntpath.py", line 75, in join
+      path = os.fspath(path)
+  TypeError: expected str, bytes or os.PathLike object, not NoneType
+Setup.py is looking for Visual Studio SDK and is not able to find it (I got this with Visual Studio 15), to workaorinf this you have to manually set the MsSdk environment variable.
+  * Search for windows.h in c:\Program Files (x86)\Microsoft SDKs
+  * ''SET MSSdk=c:\Program Files (x86)\Microsoft SDKs\Windows\v7.1A\''
+  * Run 'setup3.py -q build' or 'setup3.py -q install' command and waiting a while ... (remove the ''-q'' to have detailled build) information
+  * For a full installation process inclusing COM components do to same configuration and commands from a Command line opened 'as Adminstrator' (right click)
+  SET PYTHONDIR=C:\Apps\Python36
+  SET PATH=%PYTHONDIR%;%PATH%
+  # CD %PYTHONDIR%\pywin32-220
+  # SET MSSdk=c:\Program Files (x86)\Microsoft SDKs\Windows\v7.1A\
+  # python setup3.py -q build
+  # python setup3.py -q install
+====== Development Rules ======
+===== Fundamental Rules =====
-== RUL_GEN_002 Important Rule ==
+== RUL_GEN_001 Important Rule ==
 <note tip>
 If you don't understand why you should not modify a line, **DON'T MODIFY IT!**
 </note>
-== RUL_GEN_003 More Important Rule ==
+== RUL_GEN_002 More Important Rule ==
 Don't modify a line just to make it nicer, better, what ever justification you want, until there is a declared issue or an enhancement or task assigned to you linked with the line.
-== RUL_GEN_004 Mosy Important Rule ==
+== RUL_GEN_004 Most Important Rule ==
 <note warning>
 **In any case, Keep it simple**
 </note>
-===== Coding Rules =====
+== RUL_GEN_005 Guru rule==
-== RUL_COD_001 ==
+Do what I say, Don't do what I do.
+===== Comment Rules =====
+== RUL_CMT_001 Comments ==
+A comment is there to explain the code not to rephrase it.\\
+Comment shall not contradict the code, update the comment with the code.
+== RUL_CMT_002 Doc Strings ==
+Always use DocStrings for Files, Class and functions comment block.\\
+== RUL_CMT_004 DocString is for users ==
+DocString section is for user of the element not for developper/maintainer. It shall explain how to use the class/function, not how it has been developped.
+== RUL_CMT_003 Maintainer comments ==
+Use standard comment immediatly of SocString section for developper/maintainer comments explaining design trick of a class/function.
+===== Coding Rules =====
+== RUL_COD_001 : Python version ==
+Python 3.7 is the preferred Python version. If Python2 is required use Python 2.7.<latest>\\
+== RUL_COD_002 ==
 Follow the Python development guidelines described in [[https://www.python.org/dev/peps/pep-0008/|PEP008]] with the following adaptations
-==== Edition Rule ====
+== RUL_COD_003 ==
+Use Pylint to check to compliance of your code **AND FIX ALL WARNINGS**.\\ Justification is required when you disable a checker.
-== ADV_GEN_005 Tab is not space==
-Configure your editor to replace tab by 4 spaces (4). If your editor is not enable to replace don't insert TAB.
-== RUL_GEN_006 Indentation ==
-Always use 4 space indentation except for arguments indentation
+==== Edition Rule ====
+== RUL_WRI_001 Tab is not space==
+Configure your editor to replace TAB character by **4 spaces**. If your editor is not enable to replace automatically, don't use TAB or better change your editor to another one.
+== RUL_WRI_002 : UTF-8 (deprecated as default in Python3) ==
+Make sure your environment is configured to use only 'UTF-8'.
+  # -- coding:UTF-8 --
+== RUL_WRI_003 : Activate future features (Python2 only) ==
+Make your Python2 code compliant with Python3 by inserting at least : (from [[https://linuxfr.org/news/python-pour-la-rentree-2019-partie-2-48277b5e-c1a0-441e-836a-5c9536c4a8d6|Python pour la rentrée 2019 — partie 2]])
+  from __future__ import absolute_import
+  from __future__ import division
+  from __future__ import print_function
+  from __future__ import unicode_literals
+  from builtins import *
+  from future import standard_library
+  standard_library.install_aliases()
+== RUL_WRI_004 Indentation ==
+Always use **4 spaces** indentation except for function arguments indentation.(see PEP008)
+==== Strings ====
+== RUL_STR_01 bytes storage (was: str usage) ==
+Python2: Use ''str'' only for internal 7 bits characters string or ''bytes'' storage\\
+Python3: Use only ''bytes'' for bytes storage.
-=== Strings ===
-== RUL_STR_01 str usage ==
- Use ''str'' only for internal 7 bits characters string or ''bytes'' storage
 == RUL_STR_002 QString usage ==
 Use ''QString'' only for Qt API functions and methods, convert results as soon as possible to ''unicode'' to be compliant for Python functions.
 == RUL_STR_003 Use unicode ==
 For all other strings use ''unicode'' only strings.
 === Classes ===
+== RUL_CLS_001 Forget old-style class ==
+Python 2: Any class MUST inherit directly or indirectly from ``object``.
+== RUL_CLS_002 ==
+Use ``self`` to identify instance parameter and ``cls`` for class  related parameter.
+== RUL_CLS_003 ==