route.py

Provides route class.

Route dataclass

Represents a single route mapping.

Parameters:

Name	Type	Description	Default
endpoint	str	Route endpoint. Can contain optional path parameters with converter names.	required
handler	Callable	Request handler.	required
methods	Iterable[str]	Allowed request methods.	required

Source code in jetweb/routing/route.py

@dataclass
class Route:
    """
    Represents a single route mapping.

    :param endpoint: Route endpoint. Can contain optional path parameters with converter names.
    :param handler: Request handler.
    :param methods: Allowed request methods.
    """
    endpoint: str
    handler: Callable
    methods: Iterable[str]
    _pattern: Pattern = field(init=False, repr=False)

    def __post_init__(self):
        self.endpoint = normalize_endpoint(self.endpoint)
        self._pattern = create_pattern(self.endpoint, CONVERTERS)

    def match_endpoint(self, endpoint: str) -> tuple[bool, dict]:
        """
        Match a request endpoint against this route's pattern.

        :param endpoint: Request endpoint for matching.
        :returns: True if endpoint is matched and parsed path parameters.
        """
        match = self._pattern.match(endpoint)
        path_params = match.groupdict() if match else {}

        return bool(match), convert_path_params(self.endpoint, path_params, CONVERTERS)

    def match_method(self, method: str) -> bool:
        """
        Match a request method against this route's allowed methods.

        :returns: True if method is matched.
        """
        return method in self.methods or "*" in self.methods

match_endpoint(endpoint)

Match a request endpoint against this route's pattern.

Parameters:

Name	Type	Description	Default
endpoint	str	Request endpoint for matching.	required

Returns:

Type	Description
tuple[bool, dict]	True if endpoint is matched and parsed path parameters.

Source code in jetweb/routing/route.py

def match_endpoint(self, endpoint: str) -> tuple[bool, dict]:
    """
    Match a request endpoint against this route's pattern.

    :param endpoint: Request endpoint for matching.
    :returns: True if endpoint is matched and parsed path parameters.
    """
    match = self._pattern.match(endpoint)
    path_params = match.groupdict() if match else {}

    return bool(match), convert_path_params(self.endpoint, path_params, CONVERTERS)

match_method(method)

Match a request method against this route's allowed methods.

Returns:

Type	Description
bool	True if method is matched.

Source code in jetweb/routing/route.py

def match_method(self, method: str) -> bool:
    """
    Match a request method against this route's allowed methods.

    :returns: True if method is matched.
    """
    return method in self.methods or "*" in self.methods