Suggestion: append info about code block number in filename

Offen

#716 erstellt am 11.7.2021 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 42/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: backend

Rechercherichtung

Beginne bei ipykernel/compiler.py ungefähr in Zeile 50, wo temporäre Dateinamen erstellt werden, und verfolge, wie die Nummer des Codeblocks verfügbar ist, wenn dieser Dateiname zusammengesetzt wird. Bestätige das gewünschte Dateinamensformat für Traceback-Einträge und prüfe vorhandene Tests rund um compiler oder die Benennung temporärer Dateien; abgeschlossen ist die Aufgabe, wenn Dateinamen die Nummer des Codeblocks beibehalten, ohne die lesbaren Pfadinformationen zu verlieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

When using IPython, the "filename" contains the number information of the code block that contains it; this is something of the form <ipython-input-N-...> where N is the code block number.

When actual temporary files are used in the ipykernel, the names created on https://github.com/ipython/ipykernel/blob/b2f1a79f64c49a1c54f2e7c79c062d6b347b9bf0/ipykernel/compiler.py#L50 lose that information.
My suggestion would be to append _number to the filename where number is the code block number. So, instead of path/to/filename.py one would have path/to/filename_number.py. This would enable a human reader to identify which code block is involved in the traceback.

Additionally, while it is currently possible to programmatically obtain the information and having a "filename" much more understable, as demonstrated in the image below, there can be some ambiguity if the exact same content appears in two code blocks, one of which appearing in a traceback (as shown in the second traceback in the image below).

Adding the _number would remove this ambiguity.