mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 10:51:14 +00:00
96 lines
4.7 KiB
Python
96 lines
4.7 KiB
Python
############################ Copyrights and license ############################
|
|
# #
|
|
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2012 Zearin <zearin@gonk.net> #
|
|
# Copyright 2013 AKFish <akfish@gmail.com> #
|
|
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2013 martinqt <m.ki2@laposte.net> #
|
|
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2016 Jannis Gebauer <ja.geb@me.com> #
|
|
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
|
|
# Copyright 2018 Wan Liuyang <tsfdye@gmail.com> #
|
|
# Copyright 2018 sfdye <tsfdye@gmail.com> #
|
|
# #
|
|
# This file is part of PyGithub. #
|
|
# http://pygithub.readthedocs.io/ #
|
|
# #
|
|
# PyGithub is free software: you can redistribute it and/or modify it under #
|
|
# the terms of the GNU Lesser General Public License as published by the Free #
|
|
# Software Foundation, either version 3 of the License, or (at your option) #
|
|
# any later version. #
|
|
# #
|
|
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
|
|
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
|
|
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
|
|
# details. #
|
|
# #
|
|
# You should have received a copy of the GNU Lesser General Public License #
|
|
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
|
|
# #
|
|
################################################################################
|
|
|
|
from typing import Any, Dict
|
|
|
|
import github.GithubObject
|
|
from github.GithubObject import Attribute
|
|
|
|
|
|
class UserKey(github.GithubObject.CompletableGithubObject):
|
|
"""
|
|
This class represents UserKeys. The reference can be found here https://docs.github.com/en/rest/reference/users#keys
|
|
"""
|
|
|
|
def _initAttributes(self) -> None:
|
|
self._id: Attribute[int] = github.GithubObject.NotSet
|
|
self._key: Attribute[str] = github.GithubObject.NotSet
|
|
self._title: Attribute[str] = github.GithubObject.NotSet
|
|
self._url: Attribute[str] = github.GithubObject.NotSet
|
|
self._verified: Attribute[bool] = github.GithubObject.NotSet
|
|
|
|
def __repr__(self) -> str:
|
|
return self.get__repr__({"id": self._id.value, "title": self._title.value})
|
|
|
|
@property
|
|
def id(self) -> int:
|
|
self._completeIfNotSet(self._id)
|
|
return self._id.value
|
|
|
|
@property
|
|
def key(self) -> str:
|
|
self._completeIfNotSet(self._key)
|
|
return self._key.value
|
|
|
|
@property
|
|
def title(self) -> str:
|
|
self._completeIfNotSet(self._title)
|
|
return self._title.value
|
|
|
|
@property
|
|
def url(self) -> str:
|
|
self._completeIfNotSet(self._url)
|
|
return self._url.value
|
|
|
|
@property
|
|
def verified(self) -> bool:
|
|
self._completeIfNotSet(self._verified)
|
|
return self._verified.value
|
|
|
|
def delete(self) -> None:
|
|
"""
|
|
:calls: `DELETE /user/keys/{id} <https://docs.github.com/en/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user>`_
|
|
:rtype: None
|
|
"""
|
|
headers, data = self._requester.requestJsonAndCheck("DELETE", self.url)
|
|
|
|
def _useAttributes(self, attributes: Dict[str, Any]) -> None:
|
|
if "id" in attributes: # pragma no branch
|
|
self._id = self._makeIntAttribute(attributes["id"])
|
|
if "key" in attributes: # pragma no branch
|
|
self._key = self._makeStringAttribute(attributes["key"])
|
|
if "title" in attributes: # pragma no branch
|
|
self._title = self._makeStringAttribute(attributes["title"])
|
|
if "url" in attributes: # pragma no branch
|
|
self._url = self._makeStringAttribute(attributes["url"])
|
|
if "verified" in attributes: # pragma no branch
|
|
self._verified = self._makeBoolAttribute(attributes["verified"])
|