twisted / twisted/klein

Field.validateValue doesn't allow an explicit `None`

Open
#287 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
838
Forks
123
Avg merge
7h 58m
Merged PRs (30d)
12

Description

I'm writing a route that takes a string or null as one of its fields. Although the type of this argument is Optional[str], the field doesn't have a default value - in this workflow, I want the client to pass null explicitly when null is intended.

However, Field.validateValue treats an explicit None as a missing value and raises. If Klein used a sentinel here instead, a client could pass an explicit null.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate Field.validateValue and the surrounding field-validation tests; the issue does not name a file or test entry point. Check how missing values are distinguished from an explicit None, then verify that explicit null is accepted while an omitted required value still raises.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.