Skip to content

check_server_result

CheckWebServerResult

Bases: ABC

Interface for checking the result of a web server request.

Source code in src/cookiecutter_python/backend/check_server_result.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class CheckWebServerResult(ABC):
    """Interface for checking the result of a web server request."""

    @property
    @abstractmethod
    def future(self):
        raise NotImplementedError

    @property
    @abstractmethod
    def name(self) -> str:
        """The name of the resource requested to search on the web server.

        Returns:
            str: the name of the resource (ie python package slug, rtd project)
        """
        raise NotImplementedError

    @property
    @abstractmethod
    def service_name(self) -> str:
        """The name of the web server.

        Returns:
            str: the name (slug) of the web server
        """
        raise NotImplementedError

name: str abstractmethod property

The name of the resource requested to search on the web server.

Returns:

Name Type Description
str str

the name of the resource (ie python package slug, rtd project)

service_name: str abstractmethod property

The name of the web server.

Returns:

Name Type Description
str str

the name (slug) of the web server