FilesExpand file tree

 main

/

commit.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

72 lines (46 loc) · 1.99 KB

 main

/

commit.py

Copy path

Top

File metadata and controls

• Code
• Blame

72 lines (46 loc) · 1.99 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

"""Commit search results implementation."""

from .. import git

from .. import models

from .. import repos

from .. import users

class CommitSearchResult(models.GitHubCore):

"""A representation of a commit search result from the API.

This object has the following attributes:

.. attribute:: author

A :class:`~github3.users.ShortUser` representing the user who

authored the found commit.

.. attribute:: comments_url

The URL to retrieve the comments on the found commit from the API.

.. attribute:: commit

A :class:`~github3.git.ShortCommit` representing the found commit.

.. attribute:: committer

A :class:`~github3.users.ShortUser` representing the user who

committed the found commit.

.. attribute:: html_url

The URL to view the found commit in a browser.

.. attribute:: repository

A :class:`~github3.repos.repo.ShortRepository` representing the

repository in which the commit was found.

.. attribute:: score

The confidence score assigned to the result.

.. attribute:: sha

The SHA1 of the found commit.

.. attribute:: text_matches

A list of the text matches in the commit that generated this result.

.. note::

To receive these, you must pass ``text_match=True`` to

:meth:`~github3.github.GitHub.search_commit`.

"""

def _update_attributes(self, data):

self._api = data["url"]

self.author = users.ShortUser(data["author"], self)

self.comments_url = data["comments_url"]

self.commit = git.ShortCommit(data["commit"], self)

self.committer = users.ShortUser(data["committer"], self)

self.html_url = data["html_url"]

self.repository = repos.ShortRepository(data["repository"], self)

self.score = data["score"]

self.sha = data["sha"]

self.text_matches = data.get("text_matches", [])

def _repr(self):

return f"<CommitSearchResult [{self.sha[:7]}]>"