Hub Python Library documentation
Взаимодействие с обсуждениями и pull request
Взаимодействие с обсуждениями и pull request
См. страницу документации HfApi для справочной информации о методах, позволяющих взаимодействовать с Pull Requests и Discussions на Hub.
- get_repo_discussions()
- get_discussion_details()
- create_discussion()
- create_pull_request()
- rename_discussion()
- comment_discussion()
- edit_discussion_comment()
- change_discussion_status()
- merge_pull_request()
Структуры данных
класс huggingface_hub.Discussion
< source >( title: strstatus: typing.Literal['open', 'closed', 'merged', 'draft']num: intrepo_id: strrepo_type: strauthor: stris_pull_request: boolcreated_at: datetimeendpoint: str )
Параметры
- title (
str) — Заголовок обсуждения / запроса на слияние - status (
str) — Статус Discussion / Pull Request. Допустимые значения:"open""closed""merged"(только для Pull Requests)"draft"(только для Pull Requests)
- num (
int) — Номер Discussion / Pull Request. - repo_id (
str) — идентификатор ("{namespace}/{repo_name}") репозитория, в котором было открыто обсуждение / запрос на слияние. - repo_type (
str) — Тип репозитория, в котором была открыта дискуссия / pull request. Возможные значения:"model","dataset","space". - author (
str) — Имя пользователя автора обсуждения / запроса на слияние. Может быть"deleted", если пользователь был удалён с тех пор. - is_pull_request (
bool) — Указывает, является ли это Pull Request. - created_at (
datetime) —datetimeсоздания Discussion / Pull Request. - endpoint (
str) — Точка входа в Hub. По умолчанию https://huggingface.co. - git_reference (
str, необязательный) — (свойство) Ссылка Git, на которую можно отправить изменения, если это Pull Request, иначеNone. - url (
str) — (свойство) URL обсуждения на Hub.
Обсуждение или Pull Request на Hub.
Этот dataclass не предназначен для непосредственного создания экземпляров.
класс huggingface_hub.DiscussionWithDetails
< source >( title: strstatus: typing.Literal['open', 'closed', 'merged', 'draft']num: intrepo_id: strrepo_type: strauthor: stris_pull_request: boolcreated_at: datetimeendpoint: strevents: listconflicting_files: list[str] | bool | Nonetarget_branch: str | Nonemerge_commit_oid: str | Nonediff: str | None )
Параметры
- title (
str) — Заголовок обсуждения / запроса на слияние - status (
str) — Статус Discussion / Pull Request. Допустимые значения:"open""closed""merged"(только для Pull Requests)"draft"(только для Pull Requests)
- num (
int) — Номер Discussion / Pull Request. - repo_id (
str) — идентификатор ("{namespace}/{repo_name}") репозитория, в котором было открыто обсуждение / запрос на слияние. - repo_type (
str) — Тип репозитория, в котором была открыта дискуссия / pull request. Возможные значения:"model","dataset","space". - author (
str) — Имя пользователя автора обсуждения / запроса на слияние. Может быть"deleted", если пользователь был удалён с тех пор. - is_pull_request (
bool) — Указывает, является ли это Pull Request. - created_at (
datetime) —datetimeсоздания Discussion / Pull Request. - events (
listиз DiscussionEvent) — СписокDiscussionEventsв этом Discussion или Pull Request. - conflicting_files (
Union[list[str], bool, None], необязательный) — Список конфликтующих файлов, если это Pull Request.None, еслиself.is_pull_requestравноFalse.True, если конфликтующие файлы есть, но получить список невозможно. - target_branch (
str, необязательный) — Ветка, в которую будут объединены изменения, если это Pull Request.None, еслиself.is_pull_requestравноFalse. - merge_commit_oid (
str, необязательный) — Если это объединённый Pull Request, здесь указывается OID/SHA коммита слияния, в противном случае —None. - diff (
str, optional) — git diff, если это Pull Request, иначеNone. - endpoint (
str) — Точка входа в Hub. По умолчанию https://huggingface.co. - git_reference (
str, необязательный) — (свойство) Ссылка Git, на которую можно отправить изменения, если это Pull Request, иначеNone. - url (
str) — (свойство) URL обсуждения на Hub.
Подкласс Discussion.
класс huggingface_hub.DiscussionEvent
< source >( id: strtype: strcreated_at: datetimeauthor: str_event: dict )
Параметры
- id (
str) — Идентификатор события. Шестнадцатеричная строка. - type (
str) — Тип события. - created_at (
datetime) — объектdatetime, содержащий метку времени создания события. - author (
str) — Имя пользователя автора обсуждения / запроса на слияние. Может быть"deleted", если пользователь был удалён с тех пор.
Событие в Обсуждении или Pull Request.
Используйте конкретные классы:
класс huggingface_hub.DiscussionComment
< source >( id: strtype: strcreated_at: datetimeauthor: str_event: dictcontent: stredited: boolhidden: bool )
Параметры
- id (
str) — Идентификатор события. Шестнадцатеричная строка. - type (
str) — Тип события. - created_at (
datetime) — объектdatetime, содержащий метку времени создания события. - author (
str) — Имя пользователя автора обсуждения / запроса на слияние. Может быть"deleted", если пользователь был удалён с тех пор. - content (
str) — Сырое содержимое комментария в формате Markdown. Упоминания, ссылки и изображения не отображаются. - edited (
bool) — Указывает, было ли это сообщение отредактировано. - hidden (
bool) — Указывает, скрыт ли этот комментарий.
Комментарий в Discussion / Pull Request.
Подкласс DiscussionEvent.
класс huggingface_hub.DiscussionStatusChange
< source >( id: strtype: strcreated_at: datetimeauthor: str_event: dictnew_status: str )
Параметры
- id (
str) — Идентификатор события. Шестнадцатеричная строка. - type (
str) — Тип события. - created_at (
datetime) — объектdatetime, содержащий метку времени создания события. - author (
str) — Имя пользователя автора обсуждения / запроса на слияние. Может быть"deleted", если пользователь был удалён с тех пор. - new_status (
str) — Статус Discussion / Pull Request после изменения. Допустимые значения:"open""closed""merged"(только для Pull Requests)
Смена статуса в Обсуждении / Pull Request.
Подкласс DiscussionEvent.
класс huggingface_hub.DiscussionCommit
< source >( id: strtype: strcreated_at: datetimeauthor: str_event: dictsummary: stroid: str )
Параметры
- id (
str) — Идентификатор события. Шестнадцатеричная строка. - type (
str) — Тип события. - created_at (
datetime) — объектdatetime, содержащий метку времени создания события. - author (
str) — Имя пользователя автора обсуждения / запроса на слияние. Может быть"deleted", если пользователь был удалён с тех пор. - summary (
str) — Сводка коммита. - oid (
str) — OID / SHA коммита в виде шестнадцатеричной строки.
Коммит в Pull Request.
Подкласс DiscussionEvent.
класс huggingface_hub.DiscussionTitleChange
< source >( id: strtype: strcreated_at: datetimeauthor: str_event: dictold_title: strnew_title: str )
Параметры
- id (
str) — Идентификатор события. Шестнадцатеричная строка. - type (
str) — Тип события. - created_at (
datetime) — объектdatetime, содержащий метку времени создания события. - author (
str) — Имя пользователя автора обсуждения / запроса на слияние. Может быть"deleted", если пользователь был удалён с тех пор. - old_title (
str) — Предыдущее название для Discussion / Pull Request. - new_title (
str) — Новый заголовок.
Событие переименования в Обсуждении / Pull Request.
Подкласс DiscussionEvent.