Runtime Inspection API

Das Inspektionsmodul stellt die Funktion inspect() bereit, die Laufzeitinformationen über eine Vielzahl von SQLAlchemy-Objekten liefert, sowohl im Core als auch im ORM.

Die Funktion inspect() ist der Einstiegspunkt zur öffentlichen API von SQLAlchemy, um die Konfiguration und Konstruktion von In-Memory-Objekten anzuzeigen. Abhängig vom Typ des an inspect() übergebenen Objekts ist der Rückgabewert entweder ein verwandtes Objekt, das eine bekannte Schnittstelle bereitstellt, oder in vielen Fällen wird das Objekt selbst zurückgegeben.

Die Begründung für inspect() ist zweigeteilt. Einerseits ersetzt sie die Notwendigkeit, sich einer Vielzahl von Funktionen zum "Abrufen von Informationen" in SQLAlchemy bewusst zu sein, wie z. B. Inspector.from_engine() (in 1.4 veraltet), instance_state(), class_mapper() und andere. Andererseits ist garantiert, dass der Rückgabewert von inspect() eine dokumentierte API befolgt, wodurch Tools von Drittanbietern, die auf SQLAlchemy-Konfigurationen aufbauen, auf zukunftssichere Weise erstellt werden können.

Objektname	Beschreibung
inspect(subject[, raiseerr])	Erzeugt ein Inspektions-Objekt für das gegebene Ziel.

function sqlalchemy.inspect(subject: Any, raiseerr: bool = True) → Any

Erzeugt ein Inspektions-Objekt für das gegebene Ziel.

Der zurückgegebene Wert kann in einigen Fällen dasselbe Objekt wie das übergebene sein, z. B. wenn ein Mapper-Objekt übergeben wird. In anderen Fällen ist es eine Instanz des registrierten Inspektions-Typs für das gegebene Objekt, z. B. wenn eine Engine übergeben wird, wird ein Inspector-Objekt zurückgegeben.

Parameter:

• subject – Das zu inspizierende Subjekt.

• raiseerr – Wenn True, wird, wenn das gegebene Subjekt keinem bekannten, von SQLAlchemy inspizierbaren Typ entspricht, sqlalchemy.exc.NoInspectionAvailable ausgelöst. Wenn False, wird None zurückgegeben.

Verfügbare Inspektionsziele

Unten ist eine Liste vieler der gängigsten Inspektionsziele aufgeführt.

• Connectable (d. h. Engine, Connection) - gibt ein Inspector-Objekt zurück.

• ClauseElement - alle SQL-Ausdruckskomponenten, einschließlich Table und Column, dienen als ihre eigenen Inspektions-Objekte, d. h. alle diese Objekte, die an inspect() übergeben werden, geben sich selbst zurück.

• object - ein übergebenes Objekt wird vom ORM auf eine Zuordnung geprüft - wenn ja, wird ein InstanceState zurückgegeben, das den zugeordneten Zustand des Objekts repräsentiert. Der InstanceState bietet auch Zugriff auf den pro Attribut-Zustand über die AttributeState-Schnittstelle sowie auf den "History"-Zustand eines jeden Attributs pro Flush über das History-Objekt.

  Siehe auch

  Inspektion zugeordneter Instanzen

• type (d. h. eine Klasse) - eine übergebene Klasse wird vom ORM auf eine Zuordnung geprüft - wenn ja, wird ein Mapper für diese Klasse zurückgegeben.

  Siehe auch

  Inspektion von Mapper-Objekten

• zugeordnetes Attribut - die Übergabe eines zugeordneten Attributs an inspect(), z. B. inspect(MyClass.some_attribute), gibt ein QueryableAttribute-Objekt zurück, das der Deskriptor ist, der mit einer zugeordneten Klasse verbunden ist. Dieser Deskriptor verweist über sein Attribut QueryableAttribute.property auf eine MapperProperty, die normalerweise eine Instanz von ColumnProperty oder RelationshipProperty ist.

• AliasedClass - gibt ein AliasedInsp-Objekt zurück.