Bug: PullRequestSimple.head.repo.owner is None

[eugene-graft]

Hi,

I think I've found a bug in the schema.

Env

• python: 3.12
• githubkit: 0.12.12

Steps to reproduce

from githubkit import GitHub

kit = GitHub()
owner="pandas-dev"
repo="pandas"
page_num = 16
resp = kit.rest.pulls.list(owner=owner, repo=repo, state="all", page=16, per_page=100)
_ = resp.parsed_data

Error

ValidationError: 1 validation error for list[PullRequestSimple]
62.head.repo.owner
  Input should be an object [type=model_type, input_value=None, input_type=NoneType]
    For further information visit https://errors.pydantic.dev/2.9/v/model_type

Potential solution

PullRequestSimple.head.repo.owner should probably be of type SimpleUser | None because the Github API returns owner: None for some pull requests.

Could you please take a look? Thank you in advance!

[eugene-graft]

An example of data that causes an error

Example of data

{'url': 'https://api.github.com/repos/pandas-dev/pandas/pulls/58912',
 'id': 1901928110,
 'node_id': 'PR_kwDOAA0YD85xXR6u',
 'html_url': 'https://github.com/pandas-dev/pandas/pull/58912',
 'diff_url': 'https://github.com/pandas-dev/pandas/pull/58912.diff',
 'patch_url': 'https://github.com/pandas-dev/pandas/pull/58912.patch',
 'issue_url': 'https://api.github.com/repos/pandas-dev/pandas/issues/58912',
 'number': 58912,
 'state': 'closed',
 'locked': False,
 'title': 'DOC: Fixes PR01, PR02 for Series.cat and Series.dt',
 'user': {'login': 'ghost',
  'id': 10137,
  'node_id': 'MDQ6VXNlcjEwMTM3',
  'avatar_url': 'https://avatars.githubusercontent.com/u/10137?v=4',
  'gravatar_id': '',
  'url': 'https://api.github.com/users/ghost',
  'html_url': 'https://github.com/ghost',
  'followers_url': 'https://api.github.com/users/ghost/followers',
  'following_url': 'https://api.github.com/users/ghost/following{/other_user}',
  'gists_url': 'https://api.github.com/users/ghost/gists{/gist_id}',
  'starred_url': 'https://api.github.com/users/ghost/starred{/owner}{/repo}',
  'subscriptions_url': 'https://api.github.com/users/ghost/subscriptions',
  'organizations_url': 'https://api.github.com/users/ghost/orgs',
  'repos_url': 'https://api.github.com/users/ghost/repos',
  'events_url': 'https://api.github.com/users/ghost/events{/privacy}',
  'received_events_url': 'https://api.github.com/users/ghost/received_events',
  'type': 'User',
  'user_view_type': 'public',
  'site_admin': False},
 'body': "Ref #58504\r\n```\r\npandas.Series.cat.add_categories PR01,PR02\r\npandas.Series.cat.as_ordered PR01\r\npandas.Series.cat.as_unordered PR01\r\npandas.Series.cat.remove_categories PR01,PR02\r\npandas.Series.cat.remove_unused_categories PR01\r\npandas.Series.cat.rename_categories PR01,PR02\r\npandas.Series.cat.reorder_categories PR01,PR02\r\npandas.Series.cat.set_categories PR01,PR02\r\npandas.Series.dt.as_unit PR01,PR02\r\npandas.Series.dt.ceil PR01,PR02\r\npandas.Series.dt.day_name PR01,PR02\r\npandas.Series.dt.floor PR01,PR02\r\npandas.Series.dt.month_name PR01,PR02\r\npandas.Series.dt.normalize PR01\r\npandas.Series.dt.round PR01,PR02\r\npandas.Series.dt.strftime PR01,PR02\r\npandas.Series.dt.to_period PR01,PR02\r\npandas.Series.dt.total_seconds PR01\r\npandas.Series.dt.tz_convert PR01,PR02\r\npandas.Series.dt.tz_localize PR01,PR02\r\n```\r\nWhen trying to fix PR01 and PR02 for Series.cat in #58750, I found that the current docstring validation raises these errors as false negatives. These false negatives occur for functions that are indirectly accessed through the Series accessors. Instead of the actual functions, they call `f(self, *args, **kwargs)` in pandas/core/accessor.py. When validating the docstrings, f's signature is used instead of the actual function's signature. PR01 is raised since the docstring does not have *args and **kwargs in the signature, and PR02 is raised since the parameters in the docstrings are not in the signature. I found this happens for Series.cat and Series.dt.\r\n\r\nI added a check before validating the docstring to replace accessor names with the actual function's name. I'm sure there's a better way to implement this, but I'm not too knowledgeable on how these accessors work exactly. I couldn't figure out a way to get the delegated function from an accessor so I ended up with this crude solution using string literals.\r\n\r\nAny suggestions or advice would be really helpful!",
 'created_at': '2024-06-04T01:22:15Z',
 'updated_at': '2024-07-24T01:23:38Z',
 'closed_at': '2024-07-24T01:23:38Z',
 'merged_at': None,
 'merge_commit_sha': '5773f9f7f9c810f04138186641953dbf27d59228',
 'assignee': None,
 'assignees': [],
 'requested_reviewers': [{'login': 'mroeschke',
   'id': 10647082,
   'node_id': 'MDQ6VXNlcjEwNjQ3MDgy',
   'avatar_url': 'https://avatars.githubusercontent.com/u/10647082?v=4',
   'gravatar_id': '',
   'url': 'https://api.github.com/users/mroeschke',
   'html_url': 'https://github.com/mroeschke',
   'followers_url': 'https://api.github.com/users/mroeschke/followers',
   'following_url': 'https://api.github.com/users/mroeschke/following{/other_user}',
   'gists_url': 'https://api.github.com/users/mroeschke/gists{/gist_id}',
   'starred_url': 'https://api.github.com/users/mroeschke/starred{/owner}{/repo}',
   'subscriptions_url': 'https://api.github.com/users/mroeschke/subscriptions',
   'organizations_url': 'https://api.github.com/users/mroeschke/orgs',
   'repos_url': 'https://api.github.com/users/mroeschke/repos',
   'events_url': 'https://api.github.com/users/mroeschke/events{/privacy}',
   'received_events_url': 'https://api.github.com/users/mroeschke/received_events',
   'type': 'User',
   'user_view_type': 'public',
   'site_admin': False}],
 'requested_teams': [],
 'labels': [],
 'milestone': None,
 'draft': False,
 'commits_url': 'https://api.github.com/repos/pandas-dev/pandas/pulls/58912/commits',
 'review_comments_url': 'https://api.github.com/repos/pandas-dev/pandas/pulls/58912/comments',
 'review_comment_url': 'https://api.github.com/repos/pandas-dev/pandas/pulls/comments{/number}',
 'comments_url': 'https://api.github.com/repos/pandas-dev/pandas/issues/58912/comments',
 'statuses_url': 'https://api.github.com/repos/pandas-dev/pandas/statuses/01ad3f9543e7253eaba283c2e1d089afa35324cc',
 'head': {'label': None,
  'ref': 'validation-docstrings',
  'sha': '01ad3f9543e7253eaba283c2e1d089afa35324cc',
  'user': None,
  'repo': {'id': 801539904,
   'node_id': 'R_kgDOL8aHQA',
   'name': 'pandas',
   'full_name': '03darius/pandas',
   'private': False,
   'owner': None,
   'html_url': 'https://github.com/03darius/pandas',
   'description': 'Flexible and powerful data analysis / manipulation library for Python, providing labeled data structures similar to R data.frame objects, statistical functions, and much more',
   'fork': True,
   'url': 'https://api.github.com/repos/03darius/pandas',
   'forks_url': 'https://api.github.com/repos/03darius/pandas/forks',
   'keys_url': 'https://api.github.com/repos/03darius/pandas/keys{/key_id}',
   'collaborators_url': 'https://api.github.com/repos/03darius/pandas/collaborators{/collaborator}',
   'teams_url': 'https://api.github.com/repos/03darius/pandas/teams',
   'hooks_url': 'https://api.github.com/repos/03darius/pandas/hooks',
   'issue_events_url': 'https://api.github.com/repos/03darius/pandas/issues/events{/number}',
   'events_url': 'https://api.github.com/repos/03darius/pandas/events',
   'assignees_url': 'https://api.github.com/repos/03darius/pandas/assignees{/user}',
   'branches_url': 'https://api.github.com/repos/03darius/pandas/branches{/branch}',
   'tags_url': 'https://api.github.com/repos/03darius/pandas/tags',
   'blobs_url': 'https://api.github.com/repos/03darius/pandas/git/blobs{/sha}',
   'git_tags_url': 'https://api.github.com/repos/03darius/pandas/git/tags{/sha}',
   'git_refs_url': 'https://api.github.com/repos/03darius/pandas/git/refs{/sha}',
   'trees_url': 'https://api.github.com/repos/03darius/pandas/git/trees{/sha}',
   'statuses_url': 'https://api.github.com/repos/03darius/pandas/statuses/{sha}',
   'languages_url': 'https://api.github.com/repos/03darius/pandas/languages',
   'stargazers_url': 'https://api.github.com/repos/03darius/pandas/stargazers',
   'contributors_url': 'https://api.github.com/repos/03darius/pandas/contributors',
   'subscribers_url': 'https://api.github.com/repos/03darius/pandas/subscribers',
   'subscription_url': 'https://api.github.com/repos/03darius/pandas/subscription',
   'commits_url': 'https://api.github.com/repos/03darius/pandas/commits{/sha}',
   'git_commits_url': 'https://api.github.com/repos/03darius/pandas/git/commits{/sha}',
   'comments_url': 'https://api.github.com/repos/03darius/pandas/comments{/number}',
   'issue_comment_url': 'https://api.github.com/repos/03darius/pandas/issues/comments{/number}',
   'contents_url': 'https://api.github.com/repos/03darius/pandas/contents/{+path}',
   'compare_url': 'https://api.github.com/repos/03darius/pandas/compare/{base}...{head}',
   'merges_url': 'https://api.github.com/repos/03darius/pandas/merges',
   'archive_url': 'https://api.github.com/repos/03darius/pandas/{archive_format}{/ref}',
   'downloads_url': 'https://api.github.com/repos/03darius/pandas/downloads',
   'issues_url': 'https://api.github.com/repos/03darius/pandas/issues{/number}',
   'pulls_url': 'https://api.github.com/repos/03darius/pandas/pulls{/number}',
   'milestones_url': 'https://api.github.com/repos/03darius/pandas/milestones{/number}',
   'notifications_url': 'https://api.github.com/repos/03darius/pandas/notifications{?since,all,participating}',
   'labels_url': 'https://api.github.com/repos/03darius/pandas/labels{/name}',
   'releases_url': 'https://api.github.com/repos/03darius/pandas/releases{/id}',
   'deployments_url': 'https://api.github.com/repos/03darius/pandas/deployments',
   'created_at': '2024-05-16T12:32:49Z',
   'updated_at': '2025-04-19T02:42:02Z',
   'pushed_at': '2024-06-04T00:29:00Z',
   'git_url': 'git://github.com/03darius/pandas.git',
   'ssh_url': 'git@github.com:03darius/pandas.git',
   'clone_url': 'https://github.com/03darius/pandas.git',
   'svn_url': 'https://github.com/03darius/pandas',
   'homepage': 'https://pandas.pydata.org',
   'size': 355404,
   'stargazers_count': 0,
   'watchers_count': 0,
   'language': None,
   'has_issues': False,
   'has_projects': True,
   'has_downloads': True,
   'has_wiki': False,
   'has_pages': False,
   'has_discussions': False,
   'forks_count': 0,
   'mirror_url': None,
   'archived': False,
   'disabled': True,
   'open_issues_count': 0,
   'license': {'key': 'bsd-3-clause',
    'name': 'BSD 3-Clause "New" or "Revised" License',
    'spdx_id': 'BSD-3-Clause',
    'url': 'https://api.github.com/licenses/bsd-3-clause',
    'node_id': 'MDc6TGljZW5zZTU='},
   'allow_forking': True,
   'is_template': False,
   'web_commit_signoff_required': False,
   'topics': [],
   'visibility': 'public',
   'forks': 0,
   'open_issues': 0,
   'watchers': 0,
   'default_branch': 'main'}},
 'base': {'label': 'pandas-dev:main',
  'ref': 'main',
  'sha': '76c7274985215c487248fa5640e12a9b32a06e8c',
  'user': {'login': 'pandas-dev',
   'id': 21206976,
   'node_id': 'MDEyOk9yZ2FuaXphdGlvbjIxMjA2OTc2',
   'avatar_url': 'https://avatars.githubusercontent.com/u/21206976?v=4',
   'gravatar_id': '',
   'url': 'https://api.github.com/users/pandas-dev',
   'html_url': 'https://github.com/pandas-dev',
   'followers_url': 'https://api.github.com/users/pandas-dev/followers',
   'following_url': 'https://api.github.com/users/pandas-dev/following{/other_user}',
   'gists_url': 'https://api.github.com/users/pandas-dev/gists{/gist_id}',
   'starred_url': 'https://api.github.com/users/pandas-dev/starred{/owner}{/repo}',
   'subscriptions_url': 'https://api.github.com/users/pandas-dev/subscriptions',
   'organizations_url': 'https://api.github.com/users/pandas-dev/orgs',
   'repos_url': 'https://api.github.com/users/pandas-dev/repos',
   'events_url': 'https://api.github.com/users/pandas-dev/events{/privacy}',
   'received_events_url': 'https://api.github.com/users/pandas-dev/received_events',
   'type': 'Organization',
   'user_view_type': 'public',
   'site_admin': False},
  'repo': {'id': 858127,
   'node_id': 'MDEwOlJlcG9zaXRvcnk4NTgxMjc=',
   'name': 'pandas',
   'full_name': 'pandas-dev/pandas',
   'private': False,
   'owner': {'login': 'pandas-dev',
    'id': 21206976,
    'node_id': 'MDEyOk9yZ2FuaXphdGlvbjIxMjA2OTc2',
    'avatar_url': 'https://avatars.githubusercontent.com/u/21206976?v=4',
    'gravatar_id': '',
    'url': 'https://api.github.com/users/pandas-dev',
    'html_url': 'https://github.com/pandas-dev',
    'followers_url': 'https://api.github.com/users/pandas-dev/followers',
    'following_url': 'https://api.github.com/users/pandas-dev/following{/other_user}',
    'gists_url': 'https://api.github.com/users/pandas-dev/gists{/gist_id}',
    'starred_url': 'https://api.github.com/users/pandas-dev/starred{/owner}{/repo}',
    'subscriptions_url': 'https://api.github.com/users/pandas-dev/subscriptions',
    'organizations_url': 'https://api.github.com/users/pandas-dev/orgs',
    'repos_url': 'https://api.github.com/users/pandas-dev/repos',
    'events_url': 'https://api.github.com/users/pandas-dev/events{/privacy}',
    'received_events_url': 'https://api.github.com/users/pandas-dev/received_events',
    'type': 'Organization',
    'user_view_type': 'public',
    'site_admin': False},
   'html_url': 'https://github.com/pandas-dev/pandas',
   'description': 'Flexible and powerful data analysis / manipulation library for Python, providing labeled data structures similar to R data.frame objects, statistical functions, and much more',
   'fork': False,
   'url': 'https://api.github.com/repos/pandas-dev/pandas',
   'forks_url': 'https://api.github.com/repos/pandas-dev/pandas/forks',
   'keys_url': 'https://api.github.com/repos/pandas-dev/pandas/keys{/key_id}',
   'collaborators_url': 'https://api.github.com/repos/pandas-dev/pandas/collaborators{/collaborator}',
   'teams_url': 'https://api.github.com/repos/pandas-dev/pandas/teams',
   'hooks_url': 'https://api.github.com/repos/pandas-dev/pandas/hooks',
   'issue_events_url': 'https://api.github.com/repos/pandas-dev/pandas/issues/events{/number}',
   'events_url': 'https://api.github.com/repos/pandas-dev/pandas/events',
   'assignees_url': 'https://api.github.com/repos/pandas-dev/pandas/assignees{/user}',
   'branches_url': 'https://api.github.com/repos/pandas-dev/pandas/branches{/branch}',
   'tags_url': 'https://api.github.com/repos/pandas-dev/pandas/tags',
   'blobs_url': 'https://api.github.com/repos/pandas-dev/pandas/git/blobs{/sha}',
   'git_tags_url': 'https://api.github.com/repos/pandas-dev/pandas/git/tags{/sha}',
   'git_refs_url': 'https://api.github.com/repos/pandas-dev/pandas/git/refs{/sha}',
   'trees_url': 'https://api.github.com/repos/pandas-dev/pandas/git/trees{/sha}',
   'statuses_url': 'https://api.github.com/repos/pandas-dev/pandas/statuses/{sha}',
   'languages_url': 'https://api.github.com/repos/pandas-dev/pandas/languages',
   'stargazers_url': 'https://api.github.com/repos/pandas-dev/pandas/stargazers',
   'contributors_url': 'https://api.github.com/repos/pandas-dev/pandas/contributors',
   'subscribers_url': 'https://api.github.com/repos/pandas-dev/pandas/subscribers',
   'subscription_url': 'https://api.github.com/repos/pandas-dev/pandas/subscription',
   'commits_url': 'https://api.github.com/repos/pandas-dev/pandas/commits{/sha}',
   'git_commits_url': 'https://api.github.com/repos/pandas-dev/pandas/git/commits{/sha}',
   'comments_url': 'https://api.github.com/repos/pandas-dev/pandas/comments{/number}',
   'issue_comment_url': 'https://api.github.com/repos/pandas-dev/pandas/issues/comments{/number}',
   'contents_url': 'https://api.github.com/repos/pandas-dev/pandas/contents/{+path}',
   'compare_url': 'https://api.github.com/repos/pandas-dev/pandas/compare/{base}...{head}',
   'merges_url': 'https://api.github.com/repos/pandas-dev/pandas/merges',
   'archive_url': 'https://api.github.com/repos/pandas-dev/pandas/{archive_format}{/ref}',
   'downloads_url': 'https://api.github.com/repos/pandas-dev/pandas/downloads',
   'issues_url': 'https://api.github.com/repos/pandas-dev/pandas/issues{/number}',
   'pulls_url': 'https://api.github.com/repos/pandas-dev/pandas/pulls{/number}',
   'milestones_url': 'https://api.github.com/repos/pandas-dev/pandas/milestones{/number}',
   'notifications_url': 'https://api.github.com/repos/pandas-dev/pandas/notifications{?since,all,participating}',
   'labels_url': 'https://api.github.com/repos/pandas-dev/pandas/labels{/name}',
   'releases_url': 'https://api.github.com/repos/pandas-dev/pandas/releases{/id}',
   'deployments_url': 'https://api.github.com/repos/pandas-dev/pandas/deployments',
   'created_at': '2010-08-24T01:37:33Z',
   'updated_at': '2025-05-05T18:01:24Z',
   'pushed_at': '2025-05-05T17:24:34Z',
   'git_url': 'git://github.com/pandas-dev/pandas.git',
   'ssh_url': 'git@github.com:pandas-dev/pandas.git',
   'clone_url': 'https://github.com/pandas-dev/pandas.git',
   'svn_url': 'https://github.com/pandas-dev/pandas',
   'homepage': 'https://pandas.pydata.org',
   'size': 367260,
   'stargazers_count': 45325,
   'watchers_count': 45325,
   'language': 'Python',
   'has_issues': True,
   'has_projects': True,
   'has_downloads': True,
   'has_wiki': False,
   'has_pages': False,
   'has_discussions': False,
   'forks_count': 18475,
   'mirror_url': None,
   'archived': False,
   'disabled': False,
   'open_issues_count': 3711,
   'license': {'key': 'bsd-3-clause',
    'name': 'BSD 3-Clause "New" or "Revised" License',
    'spdx_id': 'BSD-3-Clause',
    'url': 'https://api.github.com/licenses/bsd-3-clause',
    'node_id': 'MDc6TGljZW5zZTU='},
   'allow_forking': True,
   'is_template': False,
   'web_commit_signoff_required': False,
   'topics': ['alignment',
    'data-analysis',
    'data-science',
    'flexible',
    'pandas',
    'python'],
   'visibility': 'public',
   'forks': 18475,
   'open_issues': 3711,
   'watchers': 45325,
   'default_branch': 'main'}},
 '_links': {'self': {'href': 'https://api.github.com/repos/pandas-dev/pandas/pulls/58912'},
  'html': {'href': 'https://github.com/pandas-dev/pandas/pull/58912'},
  'issue': {'href': 'https://api.github.com/repos/pandas-dev/pandas/issues/58912'},
  'comments': {'href': 'https://api.github.com/repos/pandas-dev/pandas/issues/58912/comments'},
  'review_comments': {'href': 'https://api.github.com/repos/pandas-dev/pandas/pulls/58912/comments'},
  'review_comment': {'href': 'https://api.github.com/repos/pandas-dev/pandas/pulls/comments{/number}'},
  'commits': {'href': 'https://api.github.com/repos/pandas-dev/pandas/pulls/58912/commits'},
  'statuses': {'href': 'https://api.github.com/repos/pandas-dev/pandas/statuses/01ad3f9543e7253eaba283c2e1d089afa35324cc'}},
 'author_association': 'NONE',
 'auto_merge': None,
 'active_lock_reason': None}

[yanyongyu]

The type of the PullRequestSimple.head.repo is set to Repository, it's a widely used schema in many components. This may be hard to change. Maybe you could report this to upstream https://github.com/github/rest-api-description/ first.

head:
  type: object
  properties:
    label:
      type: string
    ref:
      type: string
    repo:
      "$ref": "#/components/schemas/repository"
    sha:
      type: string
    user:
      anyOf:
      - type: 'null'
      - "$ref": "#/components/schemas/simple-user"
  required:
  - label
  - ref
  - repo
  - sha
  - user

[yanyongyu]

For workaround, you can use resp.json() to get the content without validation currently. typing is also supported for json data.

[yanyongyu]

The owner field of the repository may be None when the user account is deleted. I think this could directly patch the repository schema.

[eugene-graft]

I confirm the PR215 fixes the original issue. Thank you