twisted / twisted/klein

allow adding custom types for URL segments

Open
#274 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Today I wanted to add a custom Enum as a route parameter. How to do this with Klein?

In Werkzeug, one does this by specifying a parameter to Map(): https://werkzeug.palletsprojects.com/en/0.15.x/routing/#maps-rules-and-adapters . I presume that converters maps a str that comes before the colon in a <> placeholder expression to a custom converter.

But Klein constructs the Map itself, and doesn't let you parameterize it, and hides it in a private variable. Exposing the Map and parameterizing its construction process wholsesale might be one way to fix this.

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

Start by tracing where Klein constructs and stores Werkzeug's Map, then compare that setup with Werkzeug's custom converter documentation. Define how custom URL segment types should be supplied and how the resulting route syntax is verified; done should include coverage for registering and using a custom converter.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.