# -*- coding: utf-8 -*- ############################ Copyrights and license ############################ # # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 Vincent Jacques # # # # This file is part of PyGithub. http://jacquev6.github.com/PyGithub/ # # # # PyGithub is free software: you can redistribute it and/or modify it under # # the terms of the GNU Lesser General Public License as published by the Free # # Software Foundation, either version 3 of the License, or (at your option) # # any later version. # # # # PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY # # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # # details. # # # # You should have received a copy of the GNU Lesser General Public License # # along with PyGithub. If not, see . # # # ################################################################################ import datetime import GithubException class _NotSetType: def __repr__(self): return "NotSet" NotSet = _NotSetType() class GithubObject(object): """ Base class for all classes representing objects returned by the API. """ def __init__(self, requester, headers, attributes, completed): self._requester = requester self._headers = headers; self._initAttributes() self._storeAndUseAttributes(attributes) def _storeAndUseAttributes(self, attributes): self._useAttributes(attributes) self._rawData = attributes @property def raw_data(self): """ :type: dict """ self._completeIfNeeded() return self._rawData @staticmethod def _parentUrl(url): return "/".join(url.split("/")[: -1]) @staticmethod def _NoneIfNotSet(value): if value is NotSet: return None else: return value @staticmethod def _parseDatetime(s): if s is None: return None elif len(s) == 24: return datetime.datetime.strptime(s, "%Y-%m-%dT%H:%M:%S.000Z") elif len(s) == 25: return datetime.datetime.strptime(s[:19], "%Y-%m-%dT%H:%M:%S") + (1 if s[19] == '-' else -1) * datetime.timedelta(hours=int(s[20:22]), minutes=int(s[23:25])) else: return datetime.datetime.strptime(s, "%Y-%m-%dT%H:%M:%SZ") class NonCompletableGithubObject(GithubObject): # def __init__(self, requester, attributes, completed): # ''' # Adapte for __init__ change, remove later # ''' # GithubObject.__init__(self, requester, {}, attributes, completed) def _completeIfNeeded(self): pass class CompletableGithubObject(GithubObject): def __init__(self, requester, attributes, completed): # Adapte for __init__ change, remove later GithubObject.__init__(self, requester, {}, attributes, completed) self.__completed = completed def _completeIfNotSet(self, value): if value is NotSet: self._completeIfNeeded() def _completeIfNeeded(self): if not self.__completed: self.__complete() def __complete(self): headers, data = self._requester.requestJsonAndCheck( "GET", self._url, None, None ) self._storeAndUseAttributes(data) self.__completed = True