Search Structures

These classes are meant to expose the entirety of an item returned as a search result by GitHub’s Search API.

Objects

class github3.search.CodeSearchResult(data, session=None)
git_url = None

URL to the Git blob endpoint

html_url = None

URL to the HTML view of the blob

name = None

Filename the match occurs in

path = None

Path in the repository to the file

repository = None

Repository the code snippet belongs to

score = None

Score of the result

sha = None

SHA in which the code can be found

text_matches = None

Text matches

class github3.search.IssueSearchResult(data, session=None)
issue = None

Issue object

score = None

Score of the result

text_matches = None

Text matches

class github3.search.RepositorySearchResult(data, session=None)
repository = None

Repository object

score = None

Score of the result

text_matches = None

Text matches

class github3.search.UserSearchResult(data, session=None)
score = None

Score of this search result

text_matches = None

Text matches

user = None

User object matching the search