FilesExpand file tree

 docs-update

/

decorators.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

83 lines (67 loc) · 2.41 KB

 docs-update

/

decorators.py

Copy path

Top

File metadata and controls

• Code
• Blame

83 lines (67 loc) · 2.41 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

# -*- coding: utf-8 -*-

"""

github3.decorators

==================

This module provides decorators to the rest of the library

"""

from functools import wraps

from requests.models import Response

import os

try: # (No coverage)

# python2

from StringIO import StringIO # (No coverage)

except ImportError: # (No coverage)

# python3

from io import BytesIO as StringIO

class RequestsStringIO(StringIO):

def read(self, n=-1, *args, **kwargs):

# StringIO is an old-style class, so can't use super

return StringIO.read(self, n)

def requires_auth(func):

"""Decorator to note which object methods require authorization."""

@wraps(func)

def auth_wrapper(self, *args, **kwargs):

auth = False

if hasattr(self, '_session'):

auth = (self._session.auth or

self._session.headers.get('Authorization'))

if auth:

return func(self, *args, **kwargs)

else:

from github3.models import GitHubError

# Mock a 401 response

r = generate_fake_error_response(

'{"message": "Requires authentication"}'.encode()

)

raise GitHubError(r)

return auth_wrapper

def requires_basic_auth(func):

"""Specific (basic) authentication decorator.

This is used to note which object methods require username/password

authorization and won't work with token based authorization.

"""

@wraps(func)

def auth_wrapper(self, *args, **kwargs):

if hasattr(self, '_session') and self._session.auth:

return func(self, *args, **kwargs)

else:

from github3.models import GitHubError

# Mock a 401 response

r = generate_fake_error_response(

('{"message": "Requires username/password authentication"}'

).encode()

)

raise GitHubError(r)

return auth_wrapper

def generate_fake_error_response(msg, status_code=401, encoding='utf-8'):

r = Response()

r.status_code = status_code

r.encoding = encoding

r.raw = RequestsStringIO(msg)

r._content_consumed = True

r._content = r.raw.read()

return r

# Use mock decorators when generating documentation, so all functino signatures

# are displayed correctly

if os.getenv('GENERATING_DOCUMENTATION', None) == 'github3':

requires_auth = requires_basic_auth = lambda x: x # noqa # (No coverage)