Comments (3)
- url_for is the only place the core project uses it. However, we've been moving towards pushing naming in Apps and Blueprints for several years now. In last LTS (for example) strict enforcement is enabled for app and blueprint naming. This is part of that shift.
- It uses handler because that's fairly descriptive for what it is. AFAIK it does not use two similarly named functions in the same example. If it does we should fix that.
- Yes, it works, which is why we have not broken that and do not have a current plan to. I'd like to strictly enforce, but there has not yet been a need to push that. Other python tools like flake8 will yell at you for this.
- What Flask does is fairly irrelevant and would not sway my opinion in either direction.
- There is not currently a unique naming requirement. I would like to enforce that, but we are several release cycles away from being able to do that.
With that all said, we probably should add the warning to 21.3 and aim for enforcement by the end of the year.
from sanic-ext.
This is discouraged for sure. It probably should be a warning by the core project.
from sanic-ext.
I surveyed the Sanic docs for a while before posting this issue, and I wonder whether duplicate route names are really discouraged.
Here are some findings:
- The API doc for
Sanic.route
says that thename
is anOptional[str]
as a "user defined route name for url_for". It suggests that a unique name is optional and only needed byurl_for
. - The Sanic user guide itself heavily uses
handler
as the function name, which is not unique. - It actually works perfectly fine if handler names are not unique.
By comparison, Flask said in its API doc that endpoint names should not duplicate, and it raises AssertionError: View function mapping is overwriting an existing endpoint function: handler
before server startup if the developer really violates this.
So if you are sure that handler names must be unique in Sanic, I would suggest a warning both in the user guide and in the Sanic code.
from sanic-ext.
Related Issues (20)
- [Feature Request] Response Compression
- [Bug] Can't use `pydantic>=2.0` model in OpenAPI definition HOT 3
- [Bug] Can't document/exclude websocket routes with OpenAPI decorator
- [Bug] Subheader "parameter" missing in sanic extensions document
- [Bug] Can't apply openapi decorators to blueprintss' routes
- [Bug]TypeError: listener() got an unexpected keyword argument 'priority' HOT 1
- [Bug] Documentation: dead link to the setting
- Query params validation is completely broken HOT 2
- Question regarding licensing info
- [Bug] Doubly defined objects in the output specification #260 HOT 2
- [Bug] The tags in OpenAPI yaml are not effective
- [Bug] Pydantic query validation with extra data not defined in model raise's KeyError HOT 5
- add project to nix packages
- Add support for scalar.com OpenAPI documentation
- [Bug] Sanic validation extension failed to validate aliased pydantic model field
- [Feature Request] Allow custom localization in `validate` function
- [Bug] Removing handlers in Background Logger extension removes only one handler.
- Question regarding `x-tagGroups` support
- [Bug] pydantic validation exception when validating unknown query strings HOT 2
- [Bug] `validate` should check passed in model type
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sanic-ext.