marshmallow-code / marshmallow-code/marshmallow
Remove unnecessary field aliases (`Str`, `Int`, `Bool`, etc.)
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 738
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 7
Description
Marshmallow/Flask-Marshmallow provides some aliases for fields, for example, `Str` and `String`. To keep everything simple and consistent, I suggest removing these aliases, so that the IDE will not prompt `Url` and `URL` when you type "U" (in that case the users have to make the choice each time).
Proposal:
Remove the following aliases:
- Str
- Int
- Bool
- Url
- UrlFor
- AbsoluteUrlFor
Keep the following:
- String
- Integer
- Boolean
- URL
- URLFor
- AbsoluteURLFor
Originally posted in https://github.com/greyli/apiflask/issues/63
Contributor guide
Research direction
Locate the Marshmallow field definitions and references for the listed aliases: Str, Int, Bool, Url, UrlFor, and AbsoluteUrlFor. Review existing tests or documentation covering these names, remove only the aliases proposed in the issue, and verify that the retained names continue to work while the removed names are no longer exposed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100