Schemas

AuthorInfo

Bases: BaseModel

date instance-attribute

email instance-attribute

name instance-attribute

BasicGitHubOwnerInfo

Bases: GraphqlQuerySchema

avatar_url instance-attribute

login instance-attribute

name instance-attribute

from_query_result(result) classmethod

BranchComparisonInfo

Bases: GraphqlQuerySchema

The comparison info extracted via graphql queries.

ahead_by instance-attribute

behind_by instance-attribute

commits instance-attribute

from_query_result(result) classmethod

GraphqlQuerySchema

Bases: BaseModel

model_config = ConfigDict(extra='forbid') class-attribute instance-attribute

LatestCommitsInfo

Bases: GraphqlQuerySchema

The latest commits info extracted via graphql queries.

commits instance-attribute

end_cursor instance-attribute

has_next_page instance-attribute

from_query_result(result) classmethod

MiniBlob

Bases: GraphqlQuerySchema

The minimal Blob info extracted via graphql queries.

byte_size = Field(alias='byteSize', validation_alias=AliasChoices('byteSize', 'byte_size')) class-attribute instance-attribute

is_binary = Field(alias='isBinary', validation_alias=AliasChoices('isBinary', 'is_binary')) class-attribute instance-attribute

node_id = Field(description='GH node_id') class-attribute instance-attribute

text = None class-attribute instance-attribute

MinimalBranchRef

Bases: BaseModel

name instance-attribute

node_id instance-attribute

MinimalCommitInfo

Bases: BaseModel

author = None class-attribute instance-attribute

message instance-attribute

node_id = Field(alias='id') class-attribute instance-attribute

MinimalLanguage

Bases: BaseModel

name instance-attribute

size instance-attribute

MinimalRepositoryInfo

Bases: BaseModel

created_at = Field(alias='createdAt') class-attribute instance-attribute

description instance-attribute

is_fork = Field(alias='isFork') class-attribute instance-attribute

is_in_organization = Field(alias='isInOrganization') class-attribute instance-attribute

is_private = Field(alias='isPrivate') class-attribute instance-attribute

name instance-attribute

updated_at = Field(alias='updatedAt') class-attribute instance-attribute

url instance-attribute

NoRefError

Bases: Exception

Raised when a ref is not found.

RateLimitInfo

Bases: GraphqlQuerySchema

limit instance-attribute

remaining instance-attribute

reset_at instance-attribute

from_query_result(result) classmethod

Repositories

Bases: GraphqlQuerySchema

end_cursor instance-attribute

has_next_page instance-attribute

nodes instance-attribute

from_query_result(result) classmethod

RepositoryInfo

Bases: GraphqlQuerySchema

branch_refs instance-attribute

branches_count instance-attribute

created_at = Field(alias='createdAt') class-attribute instance-attribute

description instance-attribute

disk_usage = Field(alias='diskUsage') class-attribute instance-attribute

end_cursor_branches = None class-attribute instance-attribute

fork_count = Field(alias='forkCount') class-attribute instance-attribute

has_next_page_branches = False class-attribute instance-attribute

is_fork = Field(alias='isFork') class-attribute instance-attribute

is_in_organization = Field(alias='isInOrganization') class-attribute instance-attribute

is_private = Field(alias='isPrivate') class-attribute instance-attribute

issues_count instance-attribute

languages instance-attribute

languages_count instance-attribute

license_name instance-attribute

name instance-attribute

owner instance-attribute

primary_language instance-attribute

pull_requests_count instance-attribute

stargazer_count = Field(alias='stargazerCount') class-attribute instance-attribute

updated_at = Field(alias='updatedAt') class-attribute instance-attribute

url instance-attribute

from_query_result(result) classmethod

Tree

Bases: GraphqlQuerySchema

The minimal Tree info extracted via graphql queries.

entries = None class-attribute instance-attribute

node_id = Field(description='GH node_id') class-attribute instance-attribute

num_nodes property

walk_all_blobs()

walk_all_miniblobs()

TreeEntry

Bases: GraphqlQuerySchema

Additional info related to Tree or Blob objects in a Tree.

name instance-attribute

object instance-attribute

oid = Field(description='GH object id') class-attribute instance-attribute

path = None class-attribute instance-attribute

type instance-attribute