GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — python-github2/github2/core.py at master · ask/python-github2 Expand file tree/ Copy pathcore.pyMore file actions 396 lines (292 loc) · 12.2 KB / Copy pathcore.pyFile metadata and controls396 lines (292 loc) · 12.2 KB 1 2 3 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 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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 # -*- coding: utf-8 -*- # Copyright (C) 2009-2012 Ask Solem <[email protected]> # Fernando Perez <[email protected]> # James Rowe <[email protected]> # Mark Paschal <[email protected]> # Patryk Zawadzki <[email protected]> # Sameer Al-Sakran <[email protected]> # Stéphane Angel <[email protected]> # Vincent Driessen <[email protected]> # # This file is part of python-github2, and is made available under the 3-clause # BSD license. See LICENSE for the full details. import logging import sys from datetime import datetime from dateutil import (parser, tz) #: Logger for core module LOGGER = logging.getLogger('github2.core') #: Running under Python 3 PY3K = sys.version_info[0] == 3 #: Running under Python 2.7, or newer PY27 = sys.version_info[:2] >= (2, 7) GITHUB_DATE_FORMAT = "%Y/%m/%d %H:%M:%S %z" # We need to manually mangle the timezone for commit date formatting because it # uses -xx:xx format COMMIT_DATE_FORMAT = "%Y-%m-%dT%H:%M:%S" #: GitHub timezone used in API output GITHUB_TZ = tz.gettz("America/Los_Angeles") #: Operate on naive :class:`datetime.datetime` objects, this is the default #: for backwards compatibility NAIVE = True def string_to_datetime(string): """Convert a string to Python datetime. :param str github_date: date string to parse """ parsed = parser.parse(string) if NAIVE: parsed = parsed.replace(tzinfo=None) return parsed def _handle_naive_datetimes(f): """Decorator to make datetime arguments use GitHub timezone. :param func f: Function to wrap """ def wrapper(datetime_): if not datetime_.tzinfo: datetime_ = datetime_.replace(tzinfo=GITHUB_TZ) else: datetime_ = datetime_.astimezone(GITHUB_TZ) return f(datetime_) wrapped = wrapper wrapped.__name__ = f.__name__ wrapped.__doc__ = ( f.__doc__ + """\n .. note:: Supports naive and timezone-aware datetimes""" ) return wrapped @_handle_naive_datetimes def datetime_to_ghdate(datetime_): """Convert Python datetime to GitHub date string. :param datetime datetime_: datetime object to convert """ return datetime_.strftime(GITHUB_DATE_FORMAT) @_handle_naive_datetimes def datetime_to_commitdate(datetime_): """Convert Python datetime to GitHub date string. :param datetime datetime_: datetime object to convert """ date_without_tz = datetime_.strftime(COMMIT_DATE_FORMAT) utcoffset = GITHUB_TZ.utcoffset(datetime_) hours, minutes = divmod(utcoffset.days * 86400 + utcoffset.seconds, 3600) return "".join([date_without_tz, "%+03d:%02d" % (hours, minutes)]) def datetime_to_isodate(datetime_): """Convert Python datetime to GitHub date string. :param str datetime_: datetime object to convert .. note:: Supports naive and timezone-aware datetimes """ if not datetime_.tzinfo: datetime_ = datetime_.replace(tzinfo=tz.tzutc()) else: datetime_ = datetime_.astimezone(tz.tzutc()) return "%sZ" % datetime_.isoformat()[:-6] class AuthError(Exception): """Requires authentication.""" def requires_auth(f): """Decorate to check a function call for authentication. Sets a ``requires_auth`` attribute on functions, for use in introspection. :param func f: Function to wrap :raises AuthError: If function called without an authenticated session """ # When Python 2.4 support is dropped move straight to functools.wraps, # don't pass go and don't collect $200. def wrapper(self, *args, **kwargs): if not self.request.access_token and not self.request.api_token: raise AuthError("%r requires an authenticated session" % f.__name__) return f(self, *args, **kwargs) wrapped = wrapper wrapped.__orig_func__ = f wrapped.__name__ = f.__name__ wrapped.__doc__ = f.__doc__ + """\n.. warning:: Requires authentication""" wrapped.__module__ = f.__module__ wrapped.requires_auth = True return wrapped def enhanced_by_auth(f): """Decorator to mark a function as enhanced by authentication. Sets a ``enhanced_by_auth`` attribute on functions, for use in introspection. :param func f: Function to wrap """ f.enhanced_by_auth = True f.__doc__ += """\n.. note:: This call is enhanced with authentication""" return f class GithubCommand(object): """Main API binding interface.""" def __init__(self, request): """Setup command object. :param github2.request.GithubRequest request: HTTP request handler """ self.request = request def make_request(self, command, *args, **kwargs): """Make an API request. Various options are supported if they exist in ``kwargs``: * The value of a ``method`` argument will define the HTTP method to perform for this request, the default is ``GET`` * The value of a ``filter`` argument will restrict the response to that data * The value of a ``page`` argument will be used to fetch a specific page of results, default of 1 is assumed if not given """ filter = kwargs.get("filter") post_data = kwargs.get("post_data") or {} page = kwargs.pop("page", 1) if page and not page == 1: post_data["page"] = page method = kwargs.get("method", "GET").upper() if method == "POST" or method == "GET" and post_data: response = self.request.post(self.domain, command, *args, **post_data) elif method == "PUT": response = self.request.put(self.domain, command, *args, **post_data) elif method == "DELETE": response = self.request.delete(self.domain, command, *args, **post_data) else: response = self.request.get(self.domain, command, *args) if filter: return response[filter] return response def get_value(self, *args, **kwargs): """Process a single-value response from the API. If a ``datatype`` parameter is given it defines the :class:`BaseData`-derived class we should build from the provided data """ datatype = kwargs.pop("datatype", None) value = self.make_request(*args, **kwargs) if datatype: if not PY27: # unicode keys are not accepted as kwargs by python, until 2.7: # http://bugs.python.org/issue2646 # So we make a local dict with the same keys but as strings: return datatype(**dict((str(k), v) for (k, v) in value.items())) else: return datatype(**value) return value def get_values(self, *args, **kwargs): """Process a multi-value response from the API. :see: :meth:`get_value` """ datatype = kwargs.pop("datatype", None) values = self.make_request(*args, **kwargs) if datatype: if not PY27: # Same as above, unicode keys will blow up in **args, so we # need to create a new 'values' dict with string keys return [datatype(**dict((str(k), v) for (k, v) in value.items())) for value in values] else: return [datatype(**value) for value in values] else: return values def doc_generator(docstring, attributes): """Utility function to augment BaseDataType docstring. :param str docstring: docstring to augment :param dict attributes: attributes to add to docstring """ docstring = docstring or "" def bullet(title, text): return """.. attribute:: %s\n\n %s\n""" % (title, text) b = "\n".join([bullet(attr_name, attr.help) for attr_name, attr in attributes.items()]) return "\n\n".join([docstring, b]) class Attribute(object): """Generic object attribute for use with :class:`BaseData`.""" def __init__(self, help): """Setup Attribute object. :param str help: Attribute description """ self.help = help def to_python(self, value): return value from_python = to_python class DateAttribute(Attribute): """Date handling attribute for use with :class:`BaseData`.""" format = "github" converter_for_format = { "github": datetime_to_ghdate, "commit": datetime_to_commitdate, "user": datetime_to_ghdate, "iso": datetime_to_isodate, } def __init__(self, *args, **kwargs): """Setup DateAttribute object. :param str format: The date format to support, see :data:`convertor_for_format` for supported options """ self.format = kwargs.pop("format", self.format) super(DateAttribute, self).__init__(*args, **kwargs) def to_python(self, value): if value and not isinstance(value, datetime): return string_to_datetime(value) return value def from_python(self, value): if value and isinstance(value, datetime): return self.converter_for_format[self.format](value) return value class BaseDataType(type): def __new__(cls, name, bases, attrs): super_new = super(BaseDataType, cls).__new__ _meta = dict([(attr_name, attr_value) for attr_name, attr_value in attrs.items() if isinstance(attr_value, Attribute)]) attrs["_meta"] = _meta attributes = _meta.keys() attrs.update(dict([(attr_name, None) for attr_name in attributes])) def _contribute_method(name, func): func.__name__ = name attrs[name] = func def constructor(self, **kwargs): for attr_name, attr_value in kwargs.items(): attr = self._meta.get(attr_name) if attr: setattr(self, attr_name, attr.to_python(attr_value)) else: setattr(self, attr_name, attr_value) _contribute_method("__init__", constructor) def iterate(self): not_empty = lambda e: e[1] is not None return iter(filter(not_empty, vars(self).items())) _contribute_method("__iter__", iterate) result_cls = super_new(cls, name, bases, attrs) result_cls.__doc__ = doc_generator(result_cls.__doc__, _meta) return result_cls # Ugly base class definition for Python 2 and 3 compatibility, where metaclass # syntax is incompatible class BaseData(BaseDataType('BaseData', (object, ), {})): """Wrapper for API responses. .. warning:: Supports subscript attribute access purely for backwards compatibility, you shouldn't rely on that functionality in new code """ def __getitem__(self, key): """Access objects's attribute using subscript notation. This is here purely to maintain compatibility when switching ``dict`` responses to ``BaseData`` derived objects. """ LOGGER.warning("Subscript access on %r is deprecated, use object " "attributes" % self.__class__.__name__) if not key in self._meta.keys(): raise KeyError(key) return getattr(self, key) def __setitem__(self, key, value): """Update object's attribute using subscript notation. :see: :meth:`BaseData.__getitem__` """ LOGGER.warning("Subscript access on %r is deprecated, use object " "attributes" % self.__class__.__name__) if not key in self._meta.keys(): raise KeyError(key) setattr(self, key, value) def repr_string(string): """Shorten string for use in repr() output. :param str string: string to operate on :return: string, with maximum length of 20 characters """ if len(string) > 20: string = string[:17] + '...' if not PY3K: string.decode('utf-8') return string |
| You are visitor 01402503 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |