executable file

·

46 lines (37 loc) · 1.19 KB

Conventions

Coding conventions

encoding: utf-8
linux line breaking
indent: 4 spaces
comment language: English

Module imports

Avoid any import with * except for PyQt5:

from PyQt5.QtCore import *
from PyQt5.QtGui import *
from PyQt5.QtWidgets import *

Order

Sort import lines and lists by alphabetic order.

Common abbreviations

import numpy as np
import slf.misc as operations

Naming conventions

variables, functions, methods: lowercase_with_underscores
class: CapWords

Common custom methods for PyQt5

_initWidgets(): fix element sizes, tooltips, ...
_setLayout(): add widgets, items and finally calls setLayouts()
_bindEvents(): bind events with methods

Logging

Use with following logging levels (with corresponding numeric value) :

CRITICAL (40)
WARNING (30)
INFO (20)
DEBUG (10)

Code documentation

Developper documentation is generated with doyxgen and provided on https://cnr-engineering.github.io/PyTelTools.

Doxygen will extract preformatted comments following some conventions.