Skip to content

base

BitbucketBase

Bases: AtlassianRestAPI

Source code in server/vendor/atlassian/bitbucket/base.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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
class BitbucketBase(AtlassianRestAPI):
    CONF_TIMEFORMAT = "%Y-%m-%dT%H:%M:%S.%f%z"
    bulk_headers = {"Content-Type": "application/vnd.atl.bitbucket.bulk+json"}

    def __init__(self, url, *args, **kwargs):
        """
        Init the rest api wrapper

        :param url: string:    The base url used for the rest api.
        :param *args: list:    The fixed arguments for the AtlassianRestApi.
        :param **kwargs: dict: The keyword arguments for the AtlassianRestApi.

        :return: nothing
        """
        self._update_data(kwargs.pop("data", {}))
        if url is None:
            url = self.get_link("self")
            if isinstance(url, list):  # Server has a list of links
                url = url[0]
        self.timeformat_lambda = kwargs.pop("timeformat_lambda", lambda x: self._default_timeformat_lambda(x))
        self._check_timeformat_lambda()
        super(BitbucketBase, self).__init__(url, *args, **kwargs)

    def __str__(self):
        return PrettyPrinter(indent=4).pformat(self.__data if self.__data else self)

    def _get_paged(
        self,
        url,
        params=None,
        data=None,
        flags=None,
        trailing=None,
        absolute=False,
    ):
        """
        Used to get the paged data

        :param url: string:                        The url to retrieve
        :param params: dict (default is None):     The parameter's
        :param data: dict (default is None):       The data
        :param flags: string[] (default is None):  The flags
        :param trailing: bool (default is None):   If True, a trailing slash is added to the url
        :param absolute: bool (default is False):  If True, the url is used absolute and not relative to the root

        :return: A generator object for the data elements
        """

        if params is None:
            params = {}

        while True:
            response = self.get(
                url,
                trailing=trailing,
                params=params,
                data=data,
                flags=flags,
                absolute=absolute,
            )
            if "values" not in response:
                return

            for value in response.get("values", []):
                yield value

            if self.cloud:
                url = response.get("next")
                if url is None:
                    break
                # From now on we have absolute URLs with parameters
                absolute = True
                # Params are now provided by the url
                params = {}
                # Trailing should not be added as it is already part of the url
                trailing = False
            else:
                if response.get("nextPageStart") is None:
                    break
                params["start"] = response.get("nextPageStart")

        return

    @staticmethod
    def _default_timeformat_lambda(timestamp):
        """
        Default time format function.

        :param timestamp: datetime str: The datetime object of the parsed string or the raw value if parsing failed

        :return: timestamp if it was a datetime object, else None
        """
        return timestamp if isinstance(timestamp, datetime) else None

    def _check_timeformat_lambda(self):
        """
        Check the lambda for the time format. Raise an exception if the value is wrong
        """
        LAMBDA = lambda: 0  # noqa: E731
        if self.timeformat_lambda is None or (
            isinstance(self.timeformat_lambda, type(LAMBDA)) and self.timeformat_lambda.__name__ == LAMBDA.__name__
        ):
            return True
        else:
            ValueError("Expected [None] or [lambda function] for argument [timeformat_func]")

    def _sub_url(self, url):
        """
        Get the full url from a relative one.

        :param url: string: The sub url

        :return: The absolute url
        """
        return self.url_joiner(self.url, url)

    @property
    def data(self):
        """
        Get the internal cached data. For data integrity a deep copy is returned.

        :return: A copy of the data cache
        """
        return copy.copy(self.__data)

    def get_data(self, id, default=None):
        """
        Get a data element from the internal data cache. For data integrity a deep copy is returned.
        If data isn't present, the default value is returned.

        :param id: string:                     The data element to return
        :param default: any (default is None): The value to return if id is not present

        :return: The requested data element
        """
        return copy.copy(self.__data[id]) if id in self.__data else default

    def get_time(self, id):
        """
        Return the time value with the expected format.

        :param id: string: The id for the time data

        :return: The time with the configured format, see timeformat_lambda.
        """
        value_str = self.get_data(id)
        if self.timeformat_lambda is None:
            return value_str

        if isinstance(value_str, str):
            # The format contains a : in the timezone which is supported from 3.7 on.
            if sys.version_info <= (3, 7):
                value_str = RE_TIMEZONE.sub(r"\1\2", value_str)
            value = datetime.strptime(value_str, self.CONF_TIMEFORMAT)
        else:
            value = value_str

        return self.timeformat_lambda(value)

    def _update_data(self, data):
        """
        Internal function to update the data.

        :param data: dict: The new data.

        :return: The updated object
        """
        self.__data = data

        return self

    @property
    def _new_session_args(self):
        """
        Get the kwargs for new objects (session, root, version,...).

        :return: A dict with the kwargs for new objects
        """
        return dict(
            session=self._session,
            cloud=self.cloud,
            api_root=self.api_root,
            api_version=self.api_version,
            timeformat_lambda=self.timeformat_lambda,
        )

data property

Get the internal cached data. For data integrity a deep copy is returned.

:return: A copy of the data cache

__init__(url, *args, **kwargs)

Init the rest api wrapper

:param url: string: The base url used for the rest api. :param args: list: The fixed arguments for the AtlassianRestApi. :param *kwargs: dict: The keyword arguments for the AtlassianRestApi.

:return: nothing

Source code in server/vendor/atlassian/bitbucket/base.py
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def __init__(self, url, *args, **kwargs):
    """
    Init the rest api wrapper

    :param url: string:    The base url used for the rest api.
    :param *args: list:    The fixed arguments for the AtlassianRestApi.
    :param **kwargs: dict: The keyword arguments for the AtlassianRestApi.

    :return: nothing
    """
    self._update_data(kwargs.pop("data", {}))
    if url is None:
        url = self.get_link("self")
        if isinstance(url, list):  # Server has a list of links
            url = url[0]
    self.timeformat_lambda = kwargs.pop("timeformat_lambda", lambda x: self._default_timeformat_lambda(x))
    self._check_timeformat_lambda()
    super(BitbucketBase, self).__init__(url, *args, **kwargs)

get_data(id, default=None)

Get a data element from the internal data cache. For data integrity a deep copy is returned. If data isn't present, the default value is returned.

:param id: string: The data element to return :param default: any (default is None): The value to return if id is not present

:return: The requested data element

Source code in server/vendor/atlassian/bitbucket/base.py
139
140
141
142
143
144
145
146
147
148
149
def get_data(self, id, default=None):
    """
    Get a data element from the internal data cache. For data integrity a deep copy is returned.
    If data isn't present, the default value is returned.

    :param id: string:                     The data element to return
    :param default: any (default is None): The value to return if id is not present

    :return: The requested data element
    """
    return copy.copy(self.__data[id]) if id in self.__data else default

get_time(id)

Return the time value with the expected format.

:param id: string: The id for the time data

:return: The time with the configured format, see timeformat_lambda.

Source code in server/vendor/atlassian/bitbucket/base.py
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def get_time(self, id):
    """
    Return the time value with the expected format.

    :param id: string: The id for the time data

    :return: The time with the configured format, see timeformat_lambda.
    """
    value_str = self.get_data(id)
    if self.timeformat_lambda is None:
        return value_str

    if isinstance(value_str, str):
        # The format contains a : in the timezone which is supported from 3.7 on.
        if sys.version_info <= (3, 7):
            value_str = RE_TIMEZONE.sub(r"\1\2", value_str)
        value = datetime.strptime(value_str, self.CONF_TIMEFORMAT)
    else:
        value = value_str

    return self.timeformat_lambda(value)