precice / precice/python-bindings

Check installed version of preCICE when import precice (python bindings)

Aperta
#165 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement usability
Lingua principale
Cython
Stelle
30
Fork
19
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

I think it would be helpful to raise a warning, if the version of the python bindings does not match the installed preCICE version. Example: User updates preCICE from version 2.3 to version 2.5 but forgets to run pip3 install --upgrade pyprecice. This works, but might lead to strange errors, because the API is not up-to-date.

We could to the following:

>> import precice
<stdin>:1: UserWarning: You are using pyprecice 2.3.0.0, but it looks like you are using preCICE version 2.5.0. Please upgrade your python bindings by running pip3 install --upgrade pyprecice.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia tracciando il punto di ingresso import precice e il modo in cui vengono esposti i binding Python e le versioni installate di preCICE. Riproduci lo scenario di mancata corrispondenza delle versioni descritto nell’issue; il lavoro è completato quando l’importazione emette il UserWarning specificato con entrambe le versioni e il comando di aggiornamento.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.