crossbario / crossbario/autobahn-python
Signature type checking is not strict
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 768
- PR merge metrics
- No merged PRs in 30d
Description
Currently if a procedure is registered and some of the parameters in its signature don't have type hinting, we ignore them. We could potentially have a "strict" mode where all the parameters in the function signature must have type hinting. Now that could be the default behavior as well, as proposed here https://github.com/crossbario/autobahn-python/pull/1307#discussion_r380292960
Currently if the method signature does not have any type hinting, we ignore that, another suggestion by @meejah here https://github.com/crossbario/autobahn-python/pull/1307#discussion_r376714002 was to raise in such cases.
This needs discussion
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the issue's linked discussion in pull request #1307 and the referenced comments. Clarify whether partially typed signatures should be rejected, whether untyped signatures should raise, and whether strict checking is opt-in or default; the issue is complete only once those behavior decisions are made and implemented with coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100