Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte
  • Quelque chose ne va pas ?
#255 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
numpy, python
Domaine
tooling

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Python
Étoiles
651
Forks
109
Merge moyen
10 j 20 h
PR mergées (30 j)
21

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de rai-opensource/spatialmath-python

Toutes les issues de rai-opensource/spatialmath-python

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.