Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

getmatrix() rejects a list of lists; revisit the base.X matrix/vector converters

Aperta
  • Qualcosa non va?
#255 1 commento 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
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
numpy, python
Ambito
tooling

Direzione di ricerca

Start with getmatrix and getvector in the spatialmath base package, plus isvector and ismatrix, and run the three examples in the issue to reproduce the TypeError and the flat-list reshape. Check spatialmath/base/types.py for Points2 and Points3. The issue leaves open whether the flat-list reshape is intended and whether the type aliases should widen, so settle those with a maintainer before changing code. Done means nested lists and tuples are converted and shape-checked, with tests for the existing converters.

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

Descrizione

getmatrix() (and getvector()) reject the most natural way to write a set of points: a list of lists. Found while adding type hints to RTB, where a 2xN path of waypoints is passed to a function.

from spatialmath.base import getmatrix
getmatrix([[0, 1, 2], [0, 1, 0]], (2, None))   # TypeError: argument must be scalar or ndarray
getmatrix([[0, 0], [1, 1], [2, 0]], (2, None))  # TypeError
getmatrix(np.zeros((2, 5)), (2, None))          # OK, (2, 5)

Two related problems:

  1. Nested lists and tuples are rejected. The function accepts a scalar, a 1D array-like or an ndarray, but not a list of rows. I would expect it to convert these with np.asarray and then check the shape against shape, raising ValueError on mismatch.
  2. A flat list is silently reshaped. getmatrix([0, 1, 2, 3], (2, None)) returns a (2, 2) array. That is convenient for (2,2) but can hide a mistake when the caller meant a path of 2 points or a different layout.

Also, Points2 and Points3 in spatialmath.base.types are plain NDArray, so the type hint says "ndarray only" while the docstrings in callers say "array_like".

Suggested direction:

  • Make getmatrix (and the other base.X... converters) accept array-likes of any nesting and validate the shape, so callers can replace hand-written np.asarray(...) plus ndim/shape checks with one call.
  • Decide whether the flat-list reshape is intended, and document it if so.
  • Consider whether Points2/Points3 should widen to accept sequences.

I'll revisit the base.getvector/getmatrix/isvector/ismatrix family together, since the same question applies to all of them.

Lingua principale
Python
Stelle
651
Fork
109
Merge medio
10g 20h
PR unite (30g)
21

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 rai-opensource/spatialmath-python

Tutte le issue di rai-opensource/spatialmath-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.