xmlrpc.client.dumps() skips argument validation when Python is run with -O
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 35.9k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Bug report
Bug description:
Bug description
xmlrpc.client.dumps() currently relies on assert statements to validate public API arguments.
As a result, invalid inputs are rejected in normal execution, but the validation is silently removed when Python is run with optimization (-O), causing different runtime behavior for the same API.
The documentation states that:
paramsmust be a tuple orFaultinstance.methodresponse=Trueexpects a singleton response tuple.
However, these constraints are enforced only through assert, which is removed when __debug__ is false.
Reproducer
import xmlrpc.client as xmlrpclib
for label, call in [
("list params", lambda: xmlrpclib.dumps(["x"])),
("dict params", lambda: xmlrpclib.dumps({"x": 1})),
("string params", lambda: xmlrpclib.dumps("abc")),
("multi-value response", lambda: xmlrpclib.dumps((1, 2), methodresponse=True)),
]:
try:
result = call()
except BaseException as exc:
print(label + ":", type(exc).__name__, str(exc))
else:
print(label + ": OK")
Normal execution
python repro.py
Output:
list params: AssertionError argument must be tuple or Fault instance
dict params: AssertionError argument must be tuple or Fault instance
string params: AssertionError argument must be tuple or Fault instance
multi-value response: AssertionError response tuple must be a singleton
Optimized execution
python -O repro.py
Output:
list params: OK
dict params: OK
string params: OK
multi-value response: OK
Root cause
Lib/xmlrpc/client.py currently performs argument validation using assertions:
assert isinstance(params, (tuple, Fault)), \
"argument must be tuple or Fault instance"
assert len(params) == 1, \
"response tuple must be a singleton"
When Python is executed with -O, these assertions are removed and execution proceeds into the marshalling logic, which serializes the supplied values instead of rejecting them.
Expected behavior
Public API validation should be enforced consistently regardless of optimization mode.
Invalid values should continue to be rejected when Python is run with -O.
Actual behavior
Running under -O disables validation and allows invalid inputs to be serialized.
Suggested fix
Replace the assertion-based validation with explicit runtime checks.
Possible exception types:
TypeErrorwhenparamsis neither a tuple nor aFaultinstance.ValueErrorwhenmethodresponse=Trueis used with a tuple length other than 1.
Add regression tests to ensure behavior remains consistent under optimization.
Notes
I searched for existing issues and did not find an open report covering this specific -O behavior difference for xmlrpc.client.dumps().
This appears to be a public API consistency bug rather than a security issue.
CPython versions tested on:
CPython main branch
Operating systems tested on:
Windows
Linked PRs
- gh-151533
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Lisez Lib/xmlrpc/client.py et reproduisez le comportement avec le script fourni, à la fois lors d’une exécution normale et avec -O. Examinez la validation dans dumps(), puis ajoutez une couverture de régression pour les paramètres invalides et les réponses à plusieurs valeurs afin que le comportement reste cohérent sous optimisation.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- api
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 35/100