Unittests für Methoden einer Klasse

[Sirius3]

@__deets__: ein kleines QT-Programm wird wohl kaum 4GB brauchen.

@Atalanttore: nicht alles was auf Stackoverflow steht, passt immer und erst recht nicht auf jedes Problem. Du willst ein GUI-Programm mit pytest testen? Schwierig.
Dein Fehler hier ist aber, dass Du ein QMainWindow erzeugst, ohne dass Du eine QApplication hast.
Zum Test: _calculate_BMI hat gar keine Abhängigkeit vom Fenster, sollte also gar keine Methode sein.

[Atalanttore]

@Sirius3:

1. Wie testet man ein GUI-Programm am besten?
2. Wie erstellt man eine `QApplication` in einem `pytest`?

`_calculate_BMI()` habe ich lediglich erstellt, damit ich etwas für `pytest` zum Testen habe.

Gruß
Atalanttore

[__deets__]

@Sirius3: auf den Code habe ich nicht mal geschaut

@Atalanttore: leider ist Qt nicht so dolle zum Unit testen. Ärgert mich persönlich. Du kannst natürlich einfach eine Qapplication in deiner fixture machen. Es hört dann aber schon auf, wenn man künstliche User-Ereignisse erzeugen will. Was geht, und was ich auch mache: durch Trennung von GUI und Anwendungslogik (eh eine gute Idee) teste ich dann eben nur die letztere. Zb mit der Klasse Qsignalspy. Wobei die für PyQt wohl unnötig ist, da kann man ja auch einfach schnell ein Test-QObject machen, und das mit Signalen und Slots ausstatten.

[Atalanttore]

@__deets__: Ist die Trennung von GUI und Anwendungslogik auch eine gute Idee, wenn die Klasse mit der Anwendungslogik nur aus einer Methode und ein paar Attributen besteht?

Gruß
Atalanttore

[__deets__]

Es ist fast immer eine gute Idee. Das Risiko schlecht wartbaren Code zu schreiben weil man sich die Mühe nicht macht, überwiegt das Risiko zu kompliziert und zeitaufwändig zu arbeiten, bei weitem. Gerade bei GUIs läuft man schnell die Gefahr, Domänen-Objekte mit GUI-Objekten gleich zu setzen. Und wehe man muss dieses verklebte Wollknäuel dann entwirren...

Qt selbst und andere Toolkits versuchen das zu unterstützen durch Muster wie MVC die es dir erlauben, Daten/Modellklassen von deren Verflechtung mit der Widgethierarchie zu lösen.

[Atalanttore]

@__deets__: Ich habe wieder ein paar Nachfragen.

1. In welchem Ausnahmefall ist die Erstellung mehrerer kleiner Klassen (mit jeweils nur einer Methode und ein paar Attributen) keine gute Idee?
2. Meinst du mit Domänen-Objekte die Anwendungslogik?

@Atalanttore: leider ist Qt nicht so dolle zum Unit testen. Ärgert mich persönlich. Du kannst natürlich einfach eine Qapplication in deiner fixture machen.

test_bmi.py habe ich entsprechend geändert, aber das führt jetzt zu einer langen Fehlermeldung.

test_bmi.py:

Code: Alles auswählen

from pytest import fixture
from PyQt5.QtWidgets import QApplication

import main
import sys

@fixture
def main_window():
    app = QApplication(sys.argv)
    return main.MainWindow(app)


def test_bmi_main_window(main_window):
    assert main_window._calculate_BMI(180, 80) == 24.691358024691358

Fehlermeldung:

Code: Alles auswählen

Testing started at 16:04 ...
/usr/bin/python3.6 /snap/pycharm-community/112/helpers/pycharm/_jb_pytest_runner.py --path /home/ata/source/test_bmi.py
Launching pytest with arguments /home/ata/source/test_bmi.py in /home/ata/source

============================= test session starts ==============================
platform linux -- Python 3.6.7, pytest-4.2.1, py-1.7.0, pluggy-0.8.1
rootdir: /home/ata/source, inifile:collected 1 item

test_bmi.py E
test setup failed
@fixture
    def main_window():
        app = QApplication(sys.argv)
>       return main.MainWindow(app)

test_bmi.py:10: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

self = <main.MainWindow object at 0x7f8b3028a9d8>
parent = <PyQt5.QtWidgets.QApplication object at 0x7f8b3028a678>

    def __init__(self, parent=None):
>       super().__init__(parent)
E       TypeError: QMainWindow(parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags()): argument 1 has unexpected type 'QApplication'

main.py:12: TypeError
                                                            [100%]

==================================== ERRORS ====================================
____________________ ERROR at setup of test_bmi_main_window ____________________

    @fixture
    def main_window():
        app = QApplication(sys.argv)
>       return main.MainWindow(app)

test_bmi.py:10: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

self = <main.MainWindow object at 0x7f8b3028a9d8>
parent = <PyQt5.QtWidgets.QApplication object at 0x7f8b3028a678>

    def __init__(self, parent=None):
>       super().__init__(parent)
E       TypeError: QMainWindow(parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags()): argument 1 has unexpected type 'QApplication'

main.py:12: TypeError
=========================== 1 error in 0.34 seconds ============================
Process finished with exit code 0

Gruß
Atalanttore

[__deets__]

Wie kommst du denn nun auf das schmale Brett, dass du ploetzlich die QApplication als *Argument* an ein QWindow uebergibst. Du hast doch funktionierende Qt-Anwendungen. Wird das da auch gemacht? Ich habe das auch nirgendwo erwaehnt, das du das machen sollst. Du musst eine Instanz der QApplication erstellen. So wie in JEDEM Qt-Programm. Die wiederum ueberall in irgendwelche Konstruktoren reinzuwerfen...

Und ja, Domaenen-Objekte sind die Objekte, die deine Anwendung konzeptionell darstellen. Adressen in einer Adressverwaltung zB. Oder eine FUNKTION (weil mehr brauchst du nicht), die einen BMI ausrechnet.

Last but not least zu Frage 1: ich habe nichts zur Erstellung von kleinen Klassen gesagt. Ich habe etwas zur Vermengung von Anwendungslogik und Darstellungslogik gesagt.

[__deets__]

Um mal ein konkretes Beispiel zu nenne: dein Mainwindow oben mit _calculate_BMI ist nicht so gelungen, denn fuer diese Berechnung ist zum einen kein Objekt noetig, sondern nur die beiden Eingaben. Was du schon daran siehst, dass du noch nicht mal auf den self-Parameter zugreifst.

Du kannst jetzt also eine Funktion calc_bmi schreiben, und die testen. Und *verwenden* von deiner GUI-Klasse.

[__blackjack__]

Und vor allem kann man diese Funktion dann auch komplett ohne GUI testen.

[Atalanttore]

Wie kommst du denn nun auf das schmale Brett, dass du ploetzlich die QApplication als *Argument* an ein QWindow uebergibst. Du hast doch funktionierende Qt-Anwendungen. Wird das da auch gemacht? Ich habe das auch nirgendwo erwaehnt, das du das machen sollst. Du musst eine Instanz der QApplication erstellen. So wie in JEDEM Qt-Programm. Die wiederum ueberall in irgendwelche Konstruktoren reinzuwerfen...

In manchen der Beispielprogramme wird `QApplication` als Argument übergeben. In anderen wieder nicht.

Und ja, Domaenen-Objekte sind die Objekte, die deine Anwendung konzeptionell darstellen. Adressen in einer Adressverwaltung zB. Oder eine FUNKTION (weil mehr brauchst du nicht), die einen BMI ausrechnet.

Und vor allem kann man diese Funktion dann auch komplett ohne GUI testen.

Den Aufwand, Qt zufrieden zu stellen, kann man sich mit einer Funktion schön sparen. Es kann so einfach sein mit einer Funktion.

Last but not least zu Frage 1: ich habe nichts zur Erstellung von kleinen Klassen gesagt. Ich habe etwas zur Vermengung von Anwendungslogik und Darstellungslogik gesagt.

Weil du nichts zur Erstellung kleiner Klassen geschrieben hast, um Anwendungslogik und GUI immer zu trennen, habe ich explizit danach gefragt.


In "test_bmi.py" habe ich noch einen weiteren Fehler entdeckt. Für den pytest wurde "main" importiert, obwohl die Datei "bmi.py" heißt. Ohne den für Qt notwendigen Code ist die Datei auch stark zusammengeschrumpft. Der Test funktioniert jetzt problemlos.

test_bmi.py

Code: Alles auswählen

import bmi


def test_bmi_main_window():
    assert bmi.calculate_bmi(180, 80) == 24.691358024691358

bmi.py

Code: Alles auswählen

import sys
from PyQt5.QtWidgets import QApplication, QMainWindow
from PyQt5.uic import loadUi


def calculate_bmi(size, weight):
    return weight / (size / 100) ** 2


class MainWindow(QMainWindow):
    def __init__(self, parent=None):
        super().__init__(parent)
        loadUi("bmi.ui", self)

        self._write_size()
        self._write_weight()
        self._write_bmi()

        self.horizontalSlider_size.sliderMoved.connect(self._write_bmi)
        self.horizontalSlider_size.sliderMoved.connect(self._write_size)

        self.horizontalSlider_weight.sliderMoved.connect(self._write_bmi)
        self.horizontalSlider_weight.sliderMoved.connect(self._write_weight)

    @property
    def _size(self):
        return self.horizontalSlider_size.value()

    @property
    def _weight(self):
        return self.horizontalSlider_weight.value()

    def _write_size(self):
        self.output_size.setText(f"{self._size} cm")

    def _write_weight(self):
        self.output_weight.setText(f"{self._weight} kg")

    def _write_bmi(self):
        BMI = calculate_bmi(self._size, self._weight)
        self.output_BMI.setText(str(round(BMI, 2)))


def main():
    app = QApplication(sys.argv)
    main_window = MainWindow()
    main_window.show()
    sys.exit(app.exec_())


if __name__ == '__main__':
    main()

Gruß
Atalanttore

[__deets__]

Hast du mal ein Beispiel, wo die QApplication als erstes Argument and QMainWindow uebergeben wird? Das moechte ich sehen. Ob Leute von QMainWindow ABLEITEN, und sich dann eigene Konstruktoren bauen, an die man Hund, Katze, Maus uebergeben kann - ja gut. Aber das ist ja nicht was du gemacht hast.

[Atalanttore]

@__deets__: Hier ist so ein Beispiel. Gerade nochmal getestet und das Beispiel tut was es soll.

PyCharm zeigt bei der Übergabe von 'QApplication' an ein 'QMainWindow' immerhin folgende Warnung an:

Expected type 'Optional[QWidget]', got 'QApplication' instead
Inspection info: This inspection detects type errors in function call expressions. Due to dynamic dispatch and duck typing, this is possible in a limited but useful number of cases. Types of function parameters can be specified in docstrings or in Python 3 function annotations.

Gruß
Atalanttore

[__deets__]

Und wenn du mal genau schaust was das MainWindow (eine eigene Klasse) mit dem übergebenen Argument macht? Wird das an den konstruktor von QMainWindow übergeben?

[Atalanttore]

@__deets__: Der Konstruktor des `MainWindow` macht mit dem übergebenen Argument offensichtlich nichts. Das Programm funktioniert auch immer noch, wenn ich einen sinnlosen Textstring anstatt einem `QApplication` als Argument übergebe.

Mit zwei übergebenen Argumenten kommt es allerdings zu folgendem Fehler.

Code: Alles auswählen

main_window = MainWindow(app, sinnloser_text)
TypeError: __init__() takes from 1 to 2 positional arguments but 3 were given

Der TypeError scheint ein zusätzliches Argument zu kennen. Nach meinem Verständnis müsste die Fehlermeldung lauten, dass `__init__()` 0 bis 1 positionale Argumente übernimmt, aber 2 übergeben wurden.

Gruß
Atalanttore

[__blackjack__]

@Atalanttore: Du vergisst das implizit übergebene `self`. Damit sind das drei Argumente.

[Atalanttore]

@__blackjack__: Stimmt. Da war doch was ...

Auf welches Objekt verweist eigentlich das implizit übergebene `self` bei der Instanziierung der Klasse `MainWindow`?

Gruß
Atalanttore

[__deets__]

Na auf die MainWindow Instanz. Auf sich selbst. Eben “self”.

[Atalanttore]

Wie sinnvoll sind eigentlich `assert`-Anweisungen in Funktionen/Methoden, um sinnlose Argumente abzufangen?

Beispiel:

Code: Alles auswählen

def calculate_bmi(size, weight):
    assert size > 0, "Size is zero or negative."
    assert weight > 0, "Weight is zero or negative."
    return weight / (size / 100) ** 2

Gruß
Atalanttore

[Sirius3]

`assert` wird benutzt, um Programmierfehler aufzudecken, nicht um Benutzereingaben zu validieren. Hier würde ich einen ValueError werfen.

[Atalanttore]

In der .ui-Datei (Qt) ist der Eingabebereich so definiert, dass keine sinnlosen Werte entstehen und als Argumente übergeben werden.

Gruß
Atalanttore