tryceratops

Inspiriert von diesem Blog -Beitrag. Ich habe hier den Bauprozess dieses Tools beschrieben.

"Für diejenigen, die Dinosaurier mögen? Und saubere versuchen/außer Blöcken."

Zusammenfassung

• Installation und Verwendung
  • Installation
  • Verwendung
  • flake8 Plugin
• Verstöße
  • Autofix -Unterstützung
  • Verstöße ignorieren
  • Konfiguration
• Vorvermittlung
• Zeigen Sie Ihren Stil
• Zusätzliche Ressourcen
• Beitragen
• Protokoll ändern
• Lizenz
• Credits

---

Installation und Verwendung

Installation

 pip install tryceratops

ODER

 poetry add -D tryceratops

Verwendung

 tryceratops [filename or dir...]

Sie können experimentelle Analysatoren durch Laufen aktivieren:

 tryceratops --experimental [filename or dir...]

Sie können bestimmte Verstöße ignorieren, indem Sie wiederholt: --ignore TRYXXX :

 tryceratops --ignore TRY201 --ignore TRY202 [filename or dir...]

Sie können Diren ausschließen, indem Sie wiederholt: --exclude dir/path :

 tryceratops --exclude tests --exclude .venv [filename or dir...]

Sie können auch einige Verstöße automatisiert:

 tryceratops --autofix [filename or dir...]

flake8 Plugin

? Tryceratops ist auch ein Plugin für flake8 , also können Sie:

 ❯ flake8 --select TRY src/tests/samples/violations/call_raise_vanilla.py
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY002 Create your own exception
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY003 Avoid specifying long messages outside the exception class
src/tests/samples/violations/call_raise_vanilla.py:21:9: TRY201 Simply use 'raise' without specifying exception object again

Verstöße

Alle Verstöße und ihre Beschreibungen finden Sie in DOCS.

Autofix -Unterstützung

Bisher unterstützt Autofix nur Verstöße: Try200, Try201 und Try400.

Verstöße ignorieren

Wenn Sie einen Verstoß in einer bestimmten Datei ignorieren möchten, können Sie entweder:

• Fügen Sie einen Kommentar mit noqa an die Spitze der Datei hinzu, die Sie ignorieren möchten
• Fügen Sie der Zeile, die Sie ignorieren möchten, einen Kommentar mit noqa hinzu
• Fügen Sie einen Kommentar mit noqa: CODE in der Zeile hinzu, die Sie einen bestimmten Verstoß ignorieren möchten

Beispiel:

 def verbose_reraise_1 ():
    try :
        a = 1
    except Exception as ex :
        raise ex  # noqa: TRY202

Konfiguration

Sie können eine pyproject.toml -Datei einrichten, um Regeln festzulegen. Dies ist nützlich, um immer wieder die gleichen CLI -Flags wiederzuverwenden und hilft dabei, die Struktur Ihres Projekts zu definieren.

Beispiel:

[ tool . tryceratops ]
exclude = [ " samples " ]
ignore = [ " TRY002 " , " TRY200 " , " TRY300 " ]
experimental = false
check_pickable = false
allowed_base_exceptions = [ " MyAppBase " ]

CLI -Flags überschreiben immer die Konfigurationsdatei.

Vorvermittlung

Wenn Sie Pre-Commit verwenden möchten, fügen Sie Folgendes hinzu:

  - repo : https://github.com/guilatrova/tryceratops
    rev : v2.4.1
    hooks :
      - id : tryceratops 

Zeigen Sie Ihren Stil

Fügen Sie dieses ausgefallene Abzeichen in README.md Ihres Projekts hinzu:

 [ ![ try/except style: tryceratops ] ( https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black )] ( https://github.com/guilatrova/tryceratops ) 

Zusätzliche Ressourcen

Wenn Sie mehr über:

• Wie kann man Ausnahmen in Python strukturieren? ?
• Wie melde ich mich in Python an?
• Buch: Effektives Python

Beitragen

Vielen Dank, dass Sie überlegt haben, Tryceratops für alle besser zu machen!

Beziehen Sie sich auf Docs.

Protokoll ändern

Siehe ChangeLog.

Lizenz

MIT

Credits

Vielen Dank an Gott für die Inspiration? ☁️ ☀️

Das schwarze Projekt für Erkenntnisse.