FilesExpand file tree

 develop

/

file.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

87 lines (56 loc) · 2.32 KB

 develop

/

file.py

Copy path

Top

File metadata and controls

• Code
• Blame

87 lines (56 loc) · 2.32 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

84

85

86

87

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

"""Module containing the GistFile object."""

from __future__ import unicode_literals

from ..models import GitHubCore

class _GistFile(GitHubCore):

"""Base for GistFile classes."""

def _update_attributes(self, gistfile):

self.raw_url = gistfile['raw_url']

self.filename = gistfile['filename']

self.language = gistfile['language']

self.size = gistfile['size']

self.type = gistfile['type']

def _repr(self):

return '<{s.class_name} [{s.filename}]>'.format(s=self)

def content(self):

"""Retrieve contents of file from key 'raw_url'.

:returns: unaltered, untruncated contents of file.

:rtype: bytes

"""

resp = self._get(self.raw_url)

if self._boolean(resp, 200, 404):

return resp.content

return None

class ShortGistFile(_GistFile):

"""This represents the file object returned by interacting with gists.

The object has the following attributes as returned by the API for a Gist:

.. attribute:: raw_url

This URL provides access to the complete, untruncated content of the

file represented by this object.

.. attribute:: filename

The string for the filename.

.. attribute:: language

The GitHub detected language for the file, e.g., Erlang, Python, text.

.. attribute:: type

The mime-type of the file. Related to :attr:`language`.

.. attribute:: size

The file size in bytes.

"""

class_name = 'ShortGistFile'

class GistFile(_GistFile):

"""This represents the full file object returned by interacting with gists.

The object has all of the attributes as returned by the API for a

ShortGistFile as well as:

.. attribute:: truncated

A boolean attribute that indicates whether :attr:`original_content`

contains all of the file's contents.

.. attribute:: original_content

The contents of the file (potentially truncated) returned by the API.

If the file was truncated use :meth:`content` to retrieve it in its

entirety.

"""

class_name = 'GistFile'

def _update_attributes(self, gistfile):

super(GistFile, self)._update_attributes(gistfile)

self.original_content = gistfile['content']

self.truncated = gistfile['truncated']