Skip to content

Abc

RequestModel

class for requesting

Source code in pyclasher/api/requests/abc.py 
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
class RequestModel:
    """
    class for requesting
    """

    _data = MISSING
    _url = None
    _url_kwargs = None
    _len = None

    def __init__(self,
                 raw_url,
                 kwargs=None,
                 request_method=RequestMethods.REQUEST,
                 **url_kwargs):
        """
        sets up all parameters for a request
        :param raw_url:         the url of the request
        :param kwargs:          dict of kew word arguments that can be encoded in the API request
        :param request_method:  request method
        :param url_kwargs:      the url kwargs that are to replace in raw_url
        """

        if Client.initialized():
            global request_id

            self._request_id = request_id
            self.client = None

            self._url = raw_url.format(**url_kwargs)
            self.request_method = request_method
            self._url_kwargs = kwargs

            request_id += 1
            return

        raise NoClient

    def to_dict(self):
        if self._data is MISSING:
            raise RequestNotDone
        return self._data

    def __make_request_url(self):
        """
        method that returns the request url

        :return request_url:    full request url
        :rtype:                 str
        """
        request_url = "/".join((self.client.endpoint, quote(self._url)))
        if self._url_kwargs is not None:
            url_args = {
                key: value
                for key, value in self._url_kwargs.items()
                if value is not None
            }
            if url_args != {}:
                request_url = f"{request_url}?{urlencode(url_args)}"

        return request_url

    def __get_properties(self):
        return {
            name: prop.__get__(self)
            for name, prop in vars(self.__class__).items()
            if isinstance(prop, property)
        }

    def _get_data(self, item):
        if self._data is None:
            return None
        if self._data is MISSING:
            raise RequestNotDone
        if item in self._data:
            return self._data[item]
        else:
            return MISSING

    async def request(self, client_id=None):
        """
        makes a request to the ClashOfClans API
        """
        self.client = Client.get_instance(client_id)
        if self.client is None:
            raise NoClient
        if self.client is MISSING:
            raise InvalidClientId(f"Cannot find a client with the client_id "
                                  f"{client_id}.")

        if not self.client.is_running:
            raise ClientIsNotRunning

        future, status, error = Future(), Future(), Future()

        self.client.logger.debug(f"requesting {self._request_id}")

        await self.client.queue.put(
            future, self.__make_request_url(),
            self.request_method, None,
            status,
            error
        )

        self._data, req_status, req_error = (await future,
                                             await status,
                                             await error)

        if req_status != 200:
            raise req_error

        self.client.logger.debug(f"request {self._request_id} done")

        self.client = None
        return self

    async def __aenter__(self):
        return await self.request()

    async def __aexit__(self, exc_type, exc_val, exc_tb):
        return

    def __repr__(self):
        props = ', '.join((
            '='.join((key, str(value)))
            for key, value in self.__get_properties().items())
        )
        return f"{self.__class__.__name__}({props})"

    def __str__(self):
        return f"{self.__class__.__name__}()"

__init__(raw_url, kwargs=None, request_method=RequestMethods.REQUEST, **url_kwargs)

sets up all parameters for a request :param raw_url: the url of the request :param kwargs: dict of kew word arguments that can be encoded in the API request :param request_method: request method :param url_kwargs: the url kwargs that are to replace in raw_url

Source code in pyclasher/api/requests/abc.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def __init__(self,
             raw_url,
             kwargs=None,
             request_method=RequestMethods.REQUEST,
             **url_kwargs):
    """
    sets up all parameters for a request
    :param raw_url:         the url of the request
    :param kwargs:          dict of kew word arguments that can be encoded in the API request
    :param request_method:  request method
    :param url_kwargs:      the url kwargs that are to replace in raw_url
    """

    if Client.initialized():
        global request_id

        self._request_id = request_id
        self.client = None

        self._url = raw_url.format(**url_kwargs)
        self.request_method = request_method
        self._url_kwargs = kwargs

        request_id += 1
        return

    raise NoClient

__make_request_url()

method that returns the request url

:return request_url: full request url :rtype: str

Source code in pyclasher/api/requests/abc.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def __make_request_url(self):
    """
    method that returns the request url

    :return request_url:    full request url
    :rtype:                 str
    """
    request_url = "/".join((self.client.endpoint, quote(self._url)))
    if self._url_kwargs is not None:
        url_args = {
            key: value
            for key, value in self._url_kwargs.items()
            if value is not None
        }
        if url_args != {}:
            request_url = f"{request_url}?{urlencode(url_args)}"

    return request_url

request(client_id=None) async

makes a request to the ClashOfClans API

Source code in pyclasher/api/requests/abc.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
async def request(self, client_id=None):
    """
    makes a request to the ClashOfClans API
    """
    self.client = Client.get_instance(client_id)
    if self.client is None:
        raise NoClient
    if self.client is MISSING:
        raise InvalidClientId(f"Cannot find a client with the client_id "
                              f"{client_id}.")

    if not self.client.is_running:
        raise ClientIsNotRunning

    future, status, error = Future(), Future(), Future()

    self.client.logger.debug(f"requesting {self._request_id}")

    await self.client.queue.put(
        future, self.__make_request_url(),
        self.request_method, None,
        status,
        error
    )

    self._data, req_status, req_error = (await future,
                                         await status,
                                         await error)

    if req_status != 200:
        raise req_error

    self.client.logger.debug(f"request {self._request_id} done")

    self.client = None
    return self