Python raises a bare TypeError for a misspelled option where TypeScript raises unknown_key

Aperta
#399 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python, typescript

Direzione di ricerca

Start with src/selfgraph/client.py and compare methods such as entities.update that already use check_options; then inspect public method signatures in src/selfgraph/resources/*.py and src/selfgraph/insert.py. Reproduce the listed typos in both SDKs and trace how options reach validation. Done means unknown options across the listed Python constructors and methods raise unknown_key with a field and, where available, a suggestion.

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

Descrizione

approved-for-pr area: errors area: parity bug effort: M P3

What happens

A misspelled option on most Python methods raises the interpreter's TypeError, which has no code, field, or hint. The same call in TypeScript raises unknown_key with the field and a suggestion:

Call Python TypeScript
SelfGraph(store=s, scheme={}) TypeError: SelfGraph.__init__() got an unexpected keyword argument 'scheme' unknown_key, field scheme: unknown option 'scheme' for SelfGraph; did you mean 'schema'?
g.entities.list(limt=5) TypeError unknown_key, field limt, did you mean 'limit'?
g.entities.create("X", "P", alias=["x"]) TypeError unknown_key, field alias, did you mean 'aliases'?
g.retrieve("Ada", dept=2) TypeError unknown_key, field dept, did you mean 'depth'?
g.insert.facts({}, sourceid="s") TypeError unknown_key, field sourceid, did you mean 'source_id'?
g.maintenance.decay(halflife=1) TypeError unknown_key, field halflife

It is the same for entities.get, entities.delete, relations.create, relations.list, relations.certify, preferences.create, decisions.create, insert.text, check_answerable, run_cypher, maintenance.prune, and diff.

Python already does this for some calls: entities.update(nam=...), relations.update(properties=...), and SelfGraph.connect(stor=...) raise unknown_key with did you mean. So code that catches SelfGraphError handles a typo on those calls but crashes on all the others. An agent reading code gets nothing.

Reproduce

On 04862c4, run any call in the table in both SDKs.

Expected

unknown_key with field and did you mean for an unknown option on every public method and constructor, as in TypeScript. For example, take **options and run them through check_options, the way entities.update does.

Where

  • src/selfgraph/client.py, SelfGraph.__init__, retrieve, check_answerable, run_cypher, diff
  • src/selfgraph/resources/*.py and src/selfgraph/insert.py, the method signatures
Lingua principale
TypeScript
Stelle
173
Fork
58
Merge medio
6h
PR unite (30g)
120

Preparare l'ambiente

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.

Altre issue di hydra-db/selfgraph

Tutte le issue di hydra-db/selfgraph

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.