Allow for custom name generation

sanic/blueprints.py

@@ -391,7 +391,7 @@ def register(self, app, options):
  name = future.name
  if opt_name_prefix:
  name = f"{opt_name_prefix}_{future.name}"
- name = app._generate_name(name)
+ name = app.generate_name(name)
  host = future.host or self.host
  if isinstance(host, list):
  host = tuple(host)

sanic/mixins/base.py

@@ -1,37 +1,41 @@
-from typing import Optional
+from typing import Optional, Protocol, Union
 
 from sanic.base.meta import SanicMeta
 
 
+class NameProtocol(Protocol):
+ name: str
+
+
+class DunderNameProtocol(Protocol):
+ __name__: str
+
+
 class BaseMixin(metaclass=SanicMeta):
- """Base class for some other mixins."""
+ """Base class for various mixins."""
 
  name: str
  strict_slashes: Optional[bool]
 
- def _generate_name(self, *objects) -> str:
- name = None
-
+ def _generate_name(
+ self, *objects: Union[NameProtocol, DunderNameProtocol, str]
+ ) -> str:
  for obj in objects:
  if obj:
  if isinstance(obj, str):
  name = obj
- break
-
- try:
- name = obj.name
- except AttributeError:
- try:
- name = obj.__name__
- except AttributeError:
- continue
  else:
- break
+ name = getattr(obj, "name", getattr(obj, "__name__", None))
 
- if not name: # noqa
+ if name:
+ break
+ else:
  raise ValueError("Could not generate a name for handler")
 
  if not name.startswith(f"{self.name}."):
  name = f"{self.name}.{name}"
 
  return name
+
+ def generate_name(self, *objects) -> str:
+ return self._generate_name(*objects)

sanic/mixins/routes.py

@@ -139,7 +139,7 @@ def decorator(handler):
  # variable will be a tuple of (existing routes, handler fn)
  _, handler = handler
 
- name = self._generate_name(name, handler)
+ name = self.generate_name(name, handler)
 
  if isinstance(host, str):
  host = frozenset([host])

sanic/mixins/static.py

@@ -112,7 +112,7 @@ def static(
  ```
  """ # noqa: E501
 
- name = self._generate_name(name)
+ name = self.generate_name(name)
 
  if strict_slashes is None and self.strict_slashes is not None:
  strict_slashes = self.strict_slashes

sanic/router.py

@@ -180,7 +180,7 @@ def find_route_by_view_name(
 
  route = self.name_index.get(view_name)
  if not route:
- full_name = self.ctx.app._generate_name(view_name)
+ full_name = self.ctx.app.generate_name(view_name)
  route = self.name_index.get(full_name)
 
  if not route: