mpo22/misc-python-oop

python sanbox / object-oriented programming

setup

system wide python install:

• fedora

  sudo dnf -y install python3 python3-devel python3-devtools

• debian/ubuntu

  sudo apt-get install python3-dev python3-setuptools

virtual env:

python3 -m venv .venv
source .venv/bin/activate

python -m pip install -r requirements.txt

run

python main.py

update requirements.txt (optional)

python -m pip install -U pip-chill
python -m pip install -U pip-review

pip-review -a
pip-chill > requirements.txt

teardown

deactivate

beautifier

• uniformize code style
• improved code quality
• reduced merge diffs and conflicts

black

• https://black.readthedocs.io
• https://pypi.org/project/black/

python -m pip install -U black

python -m black --fast --check  .

python -m black --fast  .

linters

• uniformize code style
• improved code quality
• reduced bugs and code smells

pylint

• https://www.pylint.org/
• https://pypi.org/project/pylint/

python -m pip install -U pylint

python -m pylint delegation app tests

flake8 (???)

python -m pip install -U flake8

python -m flake8 .

test

• https://pytest.org
• https://pypi.org/project/pytest/

python -m pip install -U pytest

python -m pytest

coverage

• https://coverage.readthedocs.io/en/latest/

python -m pip install -U coverage

python -m coverage run -m pytest
python -m coverage report --show-missing --omit="*test*"
python -m coverage html --omit="*test*"
firefox htmlcov/index.html

doc

python -m pip install -U sphinx

PyCharm IDE (optional)

PyCharm Community Edition

https://www.jetbrains.com/fr-fr/pycharm/download/other.html

pylint integration

• https://plugins.jetbrains.com/plugin/11084-pylint
• https://github.com/leinardi/pylint-pycharm

flake8 integration (?not well integrated?)

https://gitlab.com/ramast/flake8-for-pycharm/ :

python -m pip install -U flake8-for-pycharm

test

• https://www.jetbrains.com/help/pycharm/pytest.html

coveragev (only in PyCharm Professional)

• https://www.jetbrains.com/help/pycharm/code-coverage.html

resources

reference

• Python documentation

• The Hitchhiker’s Guide to Python!

project structure

• Pypa's sample Python project

• Hitchhiker’s sample Module Repository

• https://pypi.org/project/python_boilerplate_template/

• https://setuptools.pypa.io/en/latest/userguide/package_discovery.html

• https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/

• https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-structure.html => flat layout is simple for in-development packages

• PEP 20 – The Zen of Python

object-oriented design

• SOLID

• GRASP

• Design patterns

• DI

plugins

• https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/

• https://mwax911.medium.com/building-a-plugin-architecture-with-python-7b4ab39ad4fc

test

• Python Testing Tools Taxonomy

• unittest

• pytest documentation

• TDD and Red Green Refactor

Stubs vs Mocks vs Fakes vs Spy

• https://www.martinfowler.com/articles/mocksArentStubs.html
• https://www.ankursheel.com/blog/difference-stubs-mocks-fakes-spies
• https://stackoverflow.com/questions/346372/whats-the-difference-between-faking-mocking-and-stubbing

gui

tkinter

• https://docs.python.org/3/library/tkinter.html

• https://tkdocs.com/tutorial/index.html

custom tkinter

• https://customtkinter.tomschimansky.com
• https://github.com/TomSchimansky/CustomTkinter/

system wide dependencies install:

• fedora https://pillow.readthedocs.io/en/latest/installation.html#codecell12

python -m pip install -U customtkinter

python -m customtkinter