check_engine

Engine

Source code in src/cookiecutter_python/backend/hosting_services/check_engine.py

@attr.s(auto_attribs=True, slots=True, frozen=True)
class Engine:
    config_file: Union[None, str]
    default_config: Union[None, bool]
    services_info: Tuple

    checker: Checker = attr.ib(
        default=attr.Factory(
            lambda self: Checker.from_hosting_info(
                self.config_file, self.default_config, self.services_info
            ),
            takes_self=True,
        )
    )

    handlers: Handlers = attr.ib(
        default=attr.Factory(
            lambda self: Handlers.from_checkers(self.checker), takes_self=True
        )
    )

    def __getattr__(self, name):
        return getattr(self.checker, name)

    def handle(self, request_result):
        return self.handlers(request_result)

    def check(self, servers: List[str]) -> Iterator:
        """Request Future per supported server, for web hosting service checks

        For each server the dedicated 'checker' is called, which tries to
        return a Future.

        Returns None checker's 'activation' boolean flag was off at runtime.
        Returns None if internal mechanism for determining server URL fails to
        derive the URL (atm URL is only trie d to be read from User Config yaml)

        Args:
            servers (List[str]): [description]

        Returns:
            Iterator: of custom objects with 'future' evaluatable attribute
        """
        return iter(filter(None, [getattr(self, server)() for server in servers]))

    @staticmethod
    def create(config_file: str, default_config: bool):
        """Initialize objects, for Asynchronous http with 3rd-party Services

        Objects are designed to Ask PyPI and Read The Docs, if the soon to be
        generated package name, and readthedocs project slug are available.

        These 'Checker' objects make asynchronous http requests to PyPI and RTD
        web servers, for non-blocking IO, and to avoid blocking the main thread.

        Checkers are initialized as 'Activated' if User Config is given and
        Default Config is False.

        Then each Checker (pypi, rtd) requires:
        - PyPI requires the 'pkg_name' in User's yaml Config
        - RTD requires the 'readthedocs_project_slug' in User's yaml Config

        to derive the URLs for Future Requests

        Args:
            config_file (str): user's yaml config file
            default_config (bool): default config flag
        """
        return Engine(
            config_file,
            default_config,
            # load implementations and automatically instatiate all
            tuple((HostingServices.create(x) for x in ('pypi', 'readthedocs'))),
        )

check(servers)

Request Future per supported server, for web hosting service checks

For each server the dedicated 'checker' is called, which tries to return a Future.

Returns None checker's 'activation' boolean flag was off at runtime. Returns None if internal mechanism for determining server URL fails to derive the URL (atm URL is only trie d to be read from User Config yaml)

Parameters:

Name	Type	Description	Default
servers	List[str]	[description]	required

Returns:

Name	Type	Description
Iterator	Iterator	of custom objects with 'future' evaluatable attribute

Source code in src/cookiecutter_python/backend/hosting_services/check_engine.py

def check(self, servers: List[str]) -> Iterator:
    """Request Future per supported server, for web hosting service checks

    For each server the dedicated 'checker' is called, which tries to
    return a Future.

    Returns None checker's 'activation' boolean flag was off at runtime.
    Returns None if internal mechanism for determining server URL fails to
    derive the URL (atm URL is only trie d to be read from User Config yaml)

    Args:
        servers (List[str]): [description]

    Returns:
        Iterator: of custom objects with 'future' evaluatable attribute
    """
    return iter(filter(None, [getattr(self, server)() for server in servers]))

create(config_file, default_config) staticmethod

Initialize objects, for Asynchronous http with 3rd-party Services

Objects are designed to Ask PyPI and Read The Docs, if the soon to be generated package name, and readthedocs project slug are available.

These 'Checker' objects make asynchronous http requests to PyPI and RTD web servers, for non-blocking IO, and to avoid blocking the main thread.

Checkers are initialized as 'Activated' if User Config is given and Default Config is False.

Then each Checker (pypi, rtd) requires: - PyPI requires the 'pkg_name' in User's yaml Config - RTD requires the 'readthedocs_project_slug' in User's yaml Config

to derive the URLs for Future Requests

Parameters:

Name	Type	Description	Default
config_file	str	user's yaml config file	required
default_config	bool	default config flag	required

Source code in src/cookiecutter_python/backend/hosting_services/check_engine.py

@staticmethod
def create(config_file: str, default_config: bool):
    """Initialize objects, for Asynchronous http with 3rd-party Services

    Objects are designed to Ask PyPI and Read The Docs, if the soon to be
    generated package name, and readthedocs project slug are available.

    These 'Checker' objects make asynchronous http requests to PyPI and RTD
    web servers, for non-blocking IO, and to avoid blocking the main thread.

    Checkers are initialized as 'Activated' if User Config is given and
    Default Config is False.

    Then each Checker (pypi, rtd) requires:
    - PyPI requires the 'pkg_name' in User's yaml Config
    - RTD requires the 'readthedocs_project_slug' in User's yaml Config

    to derive the URLs for Future Requests

    Args:
        config_file (str): user's yaml config file
        default_config (bool): default config flag
    """
    return Engine(
        config_file,
        default_config,
        # load implementations and automatically instatiate all
        tuple((HostingServices.create(x) for x in ('pypi', 'readthedocs'))),
    )