pysertive Download - pysertive Quellcode -Download

pysertive

AI-Quellcode

v0.0.1

Herunterladen

Pysertive ✔️

PyStive : AsStive Python Design by Contract (DBC) Toolkit

Was ist das?

PySertive ist eine Python -Bibliothek, die Dekorateure für die Implementierung von Design -Design -Prinzipien (DBC) bietet. Es vereinfacht die Durchsetzung von Voraussetzungen, Nach- und Invarianten in Ihrem Code. PySertive zielt darauf ab, ein leistungsstarkes Instrument zur Gewährleistung von Codeverhalten und -beschränkungen zu sein, die sichere, wartbare und robuste Softwareentwicklung in Python fördern.

Inhaltsverzeichnis

Merkmale
Woher, um es zu bekommen?
Schneller Start
Verwendung
Warum pysertive?
Beispiele
Beitragen
Lizenz

? Merkmale

Die Dinge, die PyStive gut machen:

Voraussetzungen: Stellen Sie sicher, dass die Funktionseingänge vor der Ausführung definierte Kriterien erfüllen.
Postkonditionen: Überprüfen Sie, ob die Funktionsausgänge nach der Ausführung den erwarteten Bedingungen entsprechen.
Invarianten: Garantieren Sie, dass bestimmte Bedingungen während des gesamten Lebenszyklus von Klasseninstanzen wahr bleiben.

PySertive ist mit Blick auf Einfachheit und Flexibilität konzipiert, sodass Sie problemlos strenge Vertragsüberprüfungen in Ihren Python -Code integrieren können, was beim Debuggen und Wartung komplexer Systeme hilft.

? Woher, um es zu bekommen?

Um pyStive zu installieren, verwenden Sie einfach PIP:

pip install pysertive

Schneller Start

Hier erfahren Sie, wie Sie schnell mit PySertive beginnen können:

 from pysertive import pre_condition , post_condition , invariant

@ pre_condition ( lambda x : x > 0 , exception_type = ValueError , message = "Input must be positive" )
def sqrt ( x ):
    return x ** 0.5

@ post_condition ( lambda result : result != None , exception_type = AssertionError , message = "Result cannot be None" )
def fetch_data ():
    return { "data" : "Here is your data" }

@ invariant ( lambda self : self . balance >= 0 , exception_type = RuntimeError , message = "Insufficient funds" )
class BankAccount :
    def __init__ ( self , balance ):
        self . balance = balance

    def deposit ( self , amount ):
        self . balance += amount

    def withdraw ( self , amount ):
        self . balance -= amount  # No need to manually check for negative balance

? Verwendung

Voraussetzungen verwenden

Stellen Sie sicher, dass die Eingaben zu Ihren Funktionen gültig sind:

 @ pre_condition ( lambda age : age >= 18 , exception_type = ValueError , message = "Must be 18 or older" )
def sign_contract ( age ):
    print ( f"Contract signed by individual aged { age } " )

Verwenden von Postkonditionen

Validieren Sie Ausgänge, nachdem Ihre Funktionen ausgeführt wurden:

 @ post_condition ( lambda result : result > 0 , exception_type = AssertionError , message = "Profit must be positive" )
def calculate_profit ( revenue , costs ):
    return revenue - costs

Verwenden von Invarianten

Durchsetzung der Klassenzustände bleiben konsistent:

 @ invariant ( lambda self : self . inventory_count >= 0 , exception_type = RuntimeError , message = "Inventory count cannot be negative" )
class Warehouse :
    def __init__ ( self , inventory_count ):
        self . inventory_count = inventory_count

    def add_stock ( self , number ):
        self . inventory_count += number

    def remove_stock ( self , number ):
        self . inventory_count -= number

❓ Warum pysertive?

Zuverlässigkeit: Durchsetzen von Regeln durchgehend in Ihrer Bewerbung.
Wartbarkeit: Leichter zu verwalten und zu aktualisieren Code mit klaren vertraglichen Verpflichtungen.
Sicherheit: verhindert unerwartete Verhaltensweisen durch strikte Überprüfung der Funktionseingänge und -ausgänge.

Beispiele

Weitere detailliertere Beispiele für die Verwendung von PyStive finden Sie in der PY -Datei examples.py im Repository. Diese Datei enthält Beispiele für die Verwendung von Voraussetzungen, Postkononditionen und Invarianten in Ihrem Python -Code.

? Beitragen

Beiträge sind willkommen! Wenn Sie einen Beitrag leisten möchten, lesen Sie bitte den beitragenden Leitfaden und öffnen Sie eine Ausgabe oder eine Pull -Anfrage.