Testen Sie Python-Code wie ein Profi mit Poetry, Tox, Nox und CI/CD

Hey!

Sie haben ein Python-Projekt und müssen sicherstellen, dass es auf jeder verfügbaren Python-Version funktioniert? Glauben Sie mir, das kann RIESIGE Kopfschmerzen bereiten. Aber keine Sorge, ich stehe hinter dir. In dieser Anleitung zeige ich Ihnen, wie Sie mit den fantastischen Tools Tox, Nox und CI/CD Ihren Code über mehrere Python-Versionen hinweg testen.

Und wissen Sie was? Es ist einfacher als Sie denken.

Wenn Sie dies gelesen haben, werden Sie Tests wie ein Profi für Python 3.8 bis 3.13 durchführen. Wir halten die Dinge einfach, unterhaltsam und absolut umsetzbar. Klingt gut? Lass uns eintauchen.

---

Warum sollten Sie sich überhaupt für das Testen mehrerer Versionen interessieren?

Stellen Sie sich Folgendes vor: Sie schreiben einen coolen Python-Code und er funktioniert auf Ihrem Computer. Aber dann, BAM! Ein Benutzer sendet Ihnen eine E-Mail mit der Aussage, dass es unter Python 3.9 nicht funktioniert. Du versuchst es und tatsächlich, etwas stimmt nicht.

Warum?

Weil Python alle diese Versionen hat und jede ihre Eigenheiten hat. Wenn Sie Ihren Code nicht auf mehreren Versionen testen, sind Sie im Blindflug.

Aber die GUTE NACHRICHT ist, dass Sie nicht mehrere Python-Versionen manuell installieren und für jede einzelne Tests durchführen müssen. Da stoßen Tox und Nox wie Superhelden auf uns zu.

---

Was sind Tox und Nox?

Lassen Sie es uns aufschlüsseln:

• Tox: Stellen Sie sich das wie einen Roboter vor, der Ihren Code in verschiedenen Python-Umgebungen testet. Es ist super organisiert und folgt Ihren Anweisungen aus einer einfachen tox.ini-Datei. Sie sagen Tox, was er tun soll, und es tut es.

• Nox: Es ist wie Tox, aber in mancher Hinsicht cooler. Warum? Denn statt einer Konfigurationsdatei können Sie ein Python-Skript (noxfile.py) schreiben. Möchten Sie benutzerdefinierte Logik oder Bedingungen hinzufügen? Nox steht hinter Ihnen.

Welches ist also besser? Ehrlich gesagt kommt es darauf an. Wenn Sie es ordentlich und unkompliziert mögen, entscheiden Sie sich für Tox. Wenn Sie der kreative Typ sind und Flexibilität lieben, ist Nox genau das Richtige für Sie.

---

Lasst uns etwas Cooles bauen

Hier ist der Deal:

Wir erstellen ein Miniprojekt mit zwei einfachen Funktionen:

• Füge zwei Zahlen hinzu.
• Subtrahieren Sie eine Zahl von einer anderen.

Wir werden einige Tests schreiben, um sicherzustellen, dass sie funktionieren, und dann verwenden wir Tox und Nox, um sie auf Python-Versionen von 3.8 bis 3.13 zu testen.

Klingt lustig, oder?

Hier ist die Dateistruktur, mit der wir arbeiten:

tox-nox-python-test-automation/
├── tox_nox_python_test_automation/
│   ├── __init__.py
│   ├── main.py
│   └── calculator.py
├── tests/
│   ├── __init__.py
│   └── test_calculator.py
├── pyproject.toml
├── tox.ini
├── noxfile.py
├── README.md

---

Schritt 1: Schreiben Sie den Code

Hier ist unser calculator.py:

def add(a, b):
    """Returns the sum of two numbers."""
    return a + b

def subtract(a, b):
    """Returns the difference of two numbers."""
    return a - b

Einfach, oder? Lasst uns dabei bleiben.

---

Schritt 2: Schreiben Sie einige Tests

Zeit sicherzustellen, dass unser Code funktioniert. Hier ist unser test_calculator.py:

tox-nox-python-test-automation/
├── tox_nox_python_test_automation/
│   ├── __init__.py
│   ├── main.py
│   └── calculator.py
├── tests/
│   ├── __init__.py
│   └── test_calculator.py
├── pyproject.toml
├── tox.ini
├── noxfile.py
├── README.md

Wir verwenden pytest, ein Testtool, das im Grunde das MVP des Python-Testens ist. Wenn Sie es noch nie benutzt haben, machen Sie sich keine Sorgen, es ist super einfach zu erlernen.

---

Schritt 3: Abhängigkeiten mit Poesie verwalten

Okay, wie stellen wir sicher, dass alle, die an diesem Projekt arbeiten, die gleichen Abhängigkeiten verwenden? Wir verwenden Poetry, das wie eine aufgeladene „requirements.txt“-Datei ist.

So sieht unser pyproject.toml aus:

def add(a, b):
    """Returns the sum of two numbers."""
    return a + b

def subtract(a, b):
    """Returns the difference of two numbers."""
    return a - b

Um alles zu installieren, führen Sie einfach Folgendes aus:

import pytest
from tox_nox_python_test_automation.calculator import add, subtract

@pytest.mark.parametrize("a, b, expected", [
    (1, 2, 3),
    (-1, 1, 0),
    (0, 0, 0),
])
def test_add(a, b, expected):
    assert add(a, b) == expected

@pytest.mark.parametrize("a, b, expected", [
    (5, 3, 2),
    (10, 5, 5),
    (-1, -1, 0),
])

def test_subtract(a, b, expected):
    assert subtract(a, b) == expected

---

Schritt 4: Führen Sie Unit-Tests mit Pytest durch

Sie können die grundlegenden Komponententests auf diese Weise ausführen:

[tool.poetry]
name = "tox_nox_python_tests"
version = "0.1.0"
description = "Testing with multiple Python versions using Tox and Nox."
authors = ["Wallace Espindola <wallace.espindola@gmail.com>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.8"
pytest = "^8.3"
nox = "^2024.10.9"
tox = "^4.23.2"

Und es wird eine standardmäßige Unit-Test-Laufausgabe angezeigt.

---

Schritt 5: Testen Sie mit Tox

Bei Tox dreht sich alles um Automatisierung. Hier ist unsere tox.ini:

poetry install

Führen Sie Tox mit einem Befehl aus:

poetry run pytest --verbose

Und bumm! Tox testet Ihren Code für alle aufgeführten Python-Versionen. Eine Beispielausgabe finden Sie hier:

---

Schritt 6: Testen Sie mit Nox

Möchten Sie mehr Kontrolle? Mit Nox können Sie kreativ werden. Hier ist unser noxfile.py:

[tox]
envlist = py38, py39, py310, py311, py312, py313

[testenv]
allowlist_externals = poetry
commands_pre =
    poetry install --no-interaction --no-root
commands =
    poetry run pytest

Nox ausführen mit:

poetry run tox

Jetzt haben Sie die volle Flexibilität, Logik hinzuzufügen, Umgebungen zu überspringen oder alles andere zu tun, was Sie brauchen. Eine Beispielausgabe finden Sie hier:

---

Schritt 7: Automatisieren Sie mit CI/CD

Warum bei lokalen Tests aufhören? Richten wir dies so ein, dass es automatisch auf GitHub Actions und GitLab CI/CD ausgeführt wird.

GitHub-Aktionen

Hier ist eine Workflow-Datei .github/workflows/python-tests.yml:

import nox

@nox.session(python=["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"])
def tests(session):
    session.install("poetry")
    session.run("poetry", "install", "--no-interaction", "--no-root")
    session.run("pytest")

GitLab CI/CD

Hier ist ein .gitlab-ci.yml:

poetry run nox

---

Lassen Sie es uns zusammenfassen

Du hast es geschafft! Sie wissen jetzt, wie Sie Python-Code über mehrere Versionen hinweg mit Tox, Nox und Poetry testen.

Das sollten Sie sich merken:

1. Tox ist Ihre Anlaufstelle für einfache, automatisierte Tests.
2. Nox gibt Ihnen die Freiheit zur Anpassung.
3. Poesie macht die Verwaltung von Abhängigkeiten zum Kinderspiel.
4. CI/CD stellt sicher, dass Ihre Tests automatisch ausgeführt werden.

---

Referenzen natürlich

Dieses Projekt verwendet Tox, Nox, Poetry und Pytest für die Testautomatisierung. Eine ausführliche Dokumentation finden Sie unter:

Tox-Dokumentation
Nox-Dokumentation
Poesiedokumentation
Pytest-Dokumentation

---

Benötigen Sie den vollständigen Code und Beispiele? Schauen Sie sich das Repo auf GitHub an: tox-nox-python-tests.

Weitere interessante Themen und technische Diskussionen finden Sie auf meiner LinkedIn-Seite.

Jetzt gehen Sie raus und machen Sie Ihre Python-Projekte kugelsicher! ?

Das obige ist der detaillierte Inhalt vonTesten Sie Python-Code wie ein Profi mit Poetry, Tox, Nox und CI/CD. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!