Praktische Beispiele für Codex CLI

Dieser Abschnitt veranschaulicht verschiedene Nutzungsszenarien der Codex CLI anhand praktischer Beispiele und hilft Ihnen, ihre Anwendung in der realen Entwicklung schnell zu beherrschen.


Code schreiben

Beispiel 1: Erstellen eines neuen Features

Lassen Sie Codex ein vollständiges Feature-Modul für Sie erstellen:

Aufgabe

Erstellen Sie eine Python-Funktion, die eine Liste von Zeichenfolgen entgegennimmt und die längste Zeichenfolge sowie ihre Indexposition zurückgibt

Codex generiert Code ähnlich dem folgenden:

Generierter Code

def find_longest_string(strings):
    """
Finden Sie die längste Zeichenfolge in einer Liste von Zeichenfolgen und ihre Indexposition.

    Argumente:
strings: Liste von Zeichenfolgen

    Rückgabe:
tuple: (längste Zeichenfolge, Indexposition)
Wenn die Liste leer ist, gib (None, -1) zurück
    """

    if not strings:
        return None, -1

    longest = max(strings, key=len)
    index = strings.index(longest)

    return longest, index


# Testbeispiel
if __name__ == "__main__":
    test_list = ["apple", "banana", "cherry", "dragonfruit"]
    result, idx = find_longest_string(test_list)
    print(f"Längster String: {result}, Index: {idx}")
    # Ausgabe: Längster String: dragonfruit, Index: 3
Der von Codex generierte Code enthält detaillierte Docstrings und Testbeispiele und kann direkt verwendet werden.

Beispiel 2: Code refaktorisieren

Bitten Sie Codex, vorhandenen Code zu refaktorisieren:

Aufgabe

Refaktorisieren Sie diese Funktion so, dass sie einen Generator verwendet:
def get_squares(n):
    result = []
    for i in range(n):
        result.append(i * i)
    return result

Codex wird den refaktorierten Code bereitstellen:

Refaktorierter Code

def get_squares(n):
    """
Erzeugt die Quadratzahlen von 0 bis n-1.

    Argumente:
n: Anzahl der zu erzeugenden Quadratzahlen

    Liefert:
int: Quadratzahlen von 0 bis n-1
    """

    for i in range(n):
        yield i * i


# Verwendungsbeispiel
for square in get_squares(5):
    print(square)
# Ausgabe: 0, 1, 4, 9, 16

Code-Review

Beispiel 1: Überprüfung von Codeproblemen

Bitten Sie Codex, den Code zu überprüfen und Verbesserungen vorzuschlagen:

Aufgabe

Überprüfen Sie die Probleme im folgenden Code:
def process_data(data):
    result = []
    for item in data:
        if item['type'] == 'a':
            result.append(item['value'] * 2)
        elif item['type'] == 'b':
            result.append(item['value'] + 10)
        elif item['type'] == 'c':
            result.append(item['value'])
    return result

Codex wird analysieren und einen Review-Bericht bereitstellen:

## 代码审查报告

### 问题
1. **缺少错误处理**:没有检查 item 是否包含必要的键
2. **类型不一致**:'c' 类型直接返回原值,而其他类型做了处理
3. **硬编码值**:乘数和加数应该作为参数或配置

### 改进建议
1. 添加默认字典或 try-except 处理
2. 统一处理逻辑
3. 将 magic numbers 提取为常量

Beispiel 2: Verwendung des /review-Befehls

Verwenden Sie den integrierten Review-Befehl in Codex:

Aufgabe

/review src/

Codex wird das gesamtesrc/Verzeichnis durchsuchen und einen umfassenden Code-Review-Bericht erstellen.


Debugging und Fehlerbehebung

Beispiel 1: Analysieren von Fehlermeldungen

Übergeben Sie die Fehlermeldung zur Analyse an Codex:

Aufgabe

Hilf mir, diesen Fehler zu analysieren:
Traceback (jüngster Aufruf zuletzt):
  Datei "app.py", Zeile 42, in <Modul>
    main()
  Datei "app.py", Zeile 38, in fetch_data()
  Datei "app.py", Zeile 25, in fetch_data
    response = requests.get(url)
  Datei "/usr/lib/python3.10/site-packages/requests/api.py", Zeile 88, in in get
    return session.request(method='GET', url=url, **kwargs)
  requests.exceptions.ConnectionError: HTTPSConnectionPool(host='api.example.com', port=443): Maximale Anzahl an Wiederholungen überschritten

Codex wird eine Analyse und eine Lösung bereitstellen:

## 错误分析

### 原因
网络连接问题 - 无法连接到 api.example.com

### 可能的原因
1. 网络不通
2. 域名解析失败
3. 服务器不可用
4. 防火墙阻止

### 建议的排查步骤
1. 检查网络连接:ping api.example.com
2. 验证域名解析:nslookup api.example.com
3. 检查端口是否开放:telnet api.example.com 443
4. 如果是本地开发,检查代理设置

Beispiel 2: Debug-Logs hinzufügen

Bitten Sie Codex, Debugging-Code hinzuzufügen:

Aufgabe

Fügen Sie Debug-Logs zu dieser Funktion hinzu:
def calculate(a, b):
    return a + b * (a - b)

Codex generiert eine Version mit Debug-Logs:

Debug-Logs hinzufügen

import logging

# Logging konfigurieren
logging.basicConfig(level=logging.DEBUG)
logger = logging.getLogger(__name__)


def calculate(a, b):
    """Berechnungsfunktion mit Debug-Logs"""
    logger.debug(f"calculate wurde mit a={a}, b={b} aufgerufen")

    result = a + b * (a - b)

    logger.debug(f"a + b = {a} + {b} = {a + b}")
    logger.debug(f"a - b = {a} - {b} = {a - b}")
    logger.debug(f"b * (a - b) = {b} * {a - b} = {b * (a - b)}")
    logger.debug(f"Endergebnis: {result}")

    return result

Dateioperationen

Beispiel 1: Stapelweises Umbenennen von Dateien

Aufgabe

Benennen Sie alle Dateien wie image_001.jpg im aktuellen Verzeichnis in image-001.jpg um (Unterstriche durch Bindestriche ersetzen)

Beispiel 2: Erstellen einer Projektstruktur

Aufgabe

Erstellen Sie eine Standardverzeichnisstruktur für ein Flask-Projekt, einschließlich:
- app.py Hauptdatei
- config.py Konfigurationsdatei
- requirements.txt
- tests/-Verzeichnis
- static/- und templates/-Verzeichnis

Codex wird die vollständige Projektstruktur erstellen und alle notwendigen Dateien generieren.

Codex wird zuerst die zu erstellenden Dateien auflisten und dann nach Bestätigung ausführen.

Befehlsausführung

Beispiel 1: Tests ausführen

Aufgabe

Führen Sie die Unit-Tests des Projekts aus

Codex wird den Projekttyp automatisch erkennen und den entsprechenden Testbefehl ausführen:

  • Python-Projekt: pytest oder unittest
  • Node.js-Projekt: npm test oder yarn test
  • Rust-Projekt: cargo test

Beispiel 2: Git-Operationen

Aufgabe

Erstellen Sie einen Git-Commit, der alle Änderungen enthält und eine passende Commit-Nachricht verwendet

Codex analysiert alle nicht committeten Änderungen und führt dann aus:

  1. git status- Änderungen anzeigen
  2. git diff- Bestimmte Änderungen überprüfen
  3. git add -A- Alle Dateien hinzufügen
  4. git commit -m "..."- Commit erstellen
Bei Git-Operationen zeigt Codex zuerst die Änderungen an und führt sie erst nach Bestätigung aus.

Projektanalyse

Beispiel 1: Die Projektstruktur verstehen

Aufgabe

Analysiere die Architektur und den Technologie-Stack dieses Projekts

Codex wird die folgenden Punkte des Projekts prüfen:

  • Konfigurationsdateien (package.json, Cargo.toml, requirements.txt usw.)
  • Verzeichnisstruktur
  • Hauptquelldateien

Anschließend wird ein detaillierter Analysebericht bereitgestellt.

Beispiel 2: Abhängigkeiten finden

Aufgabe

Finde heraus, welche Dateien auf die Datei auth.py verweisen

Planmodus

Verwende den Befehl /plan, um komplexe Aufgaben zu planen:

Aufgabe

/Plane, diesem React-Projekt eine Benutzerauthentifizierung hinzuzufügen, einschließlich Anmeldung, Registrierung und JWT-Verifizierung

Codex wird zunächst einen detaillierten Implementierungsplan anzeigen:

## 实施计划:用户认证功能

### 步骤 1:准备
- 创建用户模型
- 安装认证依赖(jsonwebtoken, bcryptjs)

### 步骤 2:后端实现
- 创建 /api/auth/register 端点
- 创建 /api/auth/login 端点
- 实现 JWT 生成和验证中间件

### 步骤 3:前端实现
- 创建登录表单组件
- 创建注册表单组件
- 添加认证状态管理

### 步骤 4:测试
- 编写后端单元测试
- 测试前端表单交互

是否确认执行此计划?
[Y] 确认 [N] 取消 [M] 修改
Der Planungsmodus ermöglicht es dir, die vollständige Vorgehensweise von Codex vor der Ausführung zu verstehen und unnötige Nacharbeit zu vermeiden.

Umfassende Beispiele

Ein vollständiges Workflow-Beispiel:

Vollständiger Workflow

# 1. Eine neue Sitzung starten
/new

# 2. Das Projekt verstehen
Welches Framework verwendet dieses Projekt? Was sind die Hauptfunktionen?

# 3. Eine neue Funktion hinzufügen
InusersFüge eine Funktion zum Senden von Verifizierungscodes im Modul hinzu; Folgendes ist zu berücksichtigen:
- Generierung von Verifizierungscodes (6Ziffern)
- 60Erneutes Senden innerhalb von Sekunden nicht möglich
- Verifizierungscode10gültig für Minuten

# 4. Test
Führe relevante Tests aus, um sicherzustellen, dass die Funktionalität ordnungsgemäß funktioniert

# 5. Code-Review
/Review

Dieses Beispiel zeigt einen typischen Entwicklungs-Workflow: Projekt verstehen → Feature implementieren → testen → Review.


Kurzübersicht der Operationen

SzenarioZu verwendender Befehl
Eine Funktion schreibenBeschreibe einfach die Anforderung
Code überprüfen/review oder "help me review..."
Probleme debuggenFügen Sie die Fehlermeldung ein und fordern Sie eine Analyse an
Befehl ausführenMit ! beginnen
Planung komplexer Aufgaben/plan + Aufgabenbeschreibung
Code verstehen"Was macht diese Funktion?"
Übung macht den Meister. Wenn Sie Codex häufiger verwenden, werden Sie geschickter, und Ihre Effizienz beim Schreiben von Code wird sich stark verbessern.
Weitere Erweiterungen