Hugging Face's logo

Hub Python Library documentation

Interagir avec les discussions et les demandes de tirage

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v2.4.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Interagir avec les discussions et les demandes de tirage

Consultez la page de documentation de HfApi pour la référence des méthodes permettant d’interagir avec les Pull Requests et les Discussions sur le Hub.

Structures de données

classe huggingface_hub.Discussion

< >

( title: strstatus: typing.Literal['open', 'closed', 'merged', 'draft']num: intrepo_id: strrepo_type: strauthor: stris_pull_request: boolcreated_at: datetimeendpoint: str )

Paramètres

  • title (str) — Le titre de la Discussion / Pull Request
  • status (str) — Le statut de la Discussion / Pull Request. Il doit être l'un des suivants :
    • "open"
    • "closed"
    • "merged" (uniquement pour les Pull Requests)
    • "draft" (uniquement pour les Pull Requests)
  • num (int) — Le numéro de la Discussion / Pull Request.
  • repo_id (str) — L’identifiant ("{namespace}/{repo_name}") du dépôt sur lequel la Discussion / Pull Request était ouverte.
  • repo_type (str) — Le type de dépôt sur lequel la Discussion / Pull Request était ouverte. Les valeurs possibles sont : "model", "dataset", "space".
  • author (str) — Nom d'utilisateur de l'auteur de la Discussion / Pull Request. Peut être "deleted" si l'utilisateur a été supprimé depuis.
  • is_pull_request (bool) — Indique s'il s'agit d'une Pull Request.
  • created_at (datetime) — La datetime de création de la Discussion / Pull Request.
  • endpoint (str) — Endpoint du Hub. La valeur par défaut est https://huggingface.co.
  • git_reference (str, facultatif) — (propriété) Référence Git vers laquelle les modifications peuvent être poussées s'il s'agit d'une Pull Request, None sinon.
  • url (str) — (propriété) URL de la discussion sur le Hub.

Une discussion ou une Pull Request sur le Hub.

Cette dataclass n'est pas destinée à être instanciée directement.

classe huggingface_hub.DiscussionWithDetails

< >

( 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 )

Paramètres

  • title (str) — Le titre de la Discussion / Pull Request
  • status (str) — Le statut de la Discussion / Pull Request. Il peut être l'un des suivants :
    • "open"
    • "closed"
    • "merged" (uniquement pour les Pull Requests)
    • "draft" (uniquement pour les Pull Requests)
  • num (int) — Le numéro de la Discussion / Pull Request.
  • repo_id (str) — L’identifiant ("{namespace}/{repo_name}") du dépôt sur lequel la Discussion / Pull Request était ouverte.
  • repo_type (str) — Le type de dépôt sur lequel la Discussion / Pull Request était ouverte. Les valeurs possibles sont : "model", "dataset", "space".
  • author (str) — Nom d'utilisateur de l'auteur de la Discussion / Pull Request. Peut être "deleted" si l'utilisateur a été supprimé depuis.
  • is_pull_request (bool) — Indique s'il s'agit d'une Pull Request.
  • created_at (datetime) — La datetime de création de la Discussion / Pull Request.
  • events (list de DiscussionEvent) — La liste des DiscussionEvents dans cette Discussion ou cette Pull Request.
  • conflicting_files (Union[list[str], bool, None], facultatif) — Une liste des fichiers en conflit s'il s'agit d'une Pull Request. None si self.is_pull_request est False. True s'il y a des fichiers en conflit mais que la liste ne peut pas être récupérée.
  • target_branch (str, facultatif) — La branche dans laquelle les modifications doivent être fusionnées s'il s'agit d'une Pull Request . None si self.is_pull_request est False.
  • merge_commit_oid (str, facultatif) — S'il s'agit d'une Pull Request fusionnée, cette valeur est définie sur l'OID / SHA de la commit de fusion, None sinon.
  • diff (str, facultatif) — La sortie de git diff s'il s'agit d'une Pull Request, None sinon.
  • endpoint (str) — Endpoint du Hub. La valeur par défaut est https://huggingface.co.
  • git_reference (str, facultatif) — (propriété) Référence Git vers laquelle les modifications peuvent être poussées s'il s'agit d'une Pull Request, None sinon.
  • url (str) — (propriété) URL de la discussion sur le Hub.

Sous-classe de Discussion.

classe huggingface_hub.DiscussionEvent

< >

( id: strtype: strcreated_at: datetimeauthor: str_event: dict )

Paramètres

  • id (str) — L'ID de l'événement. Une chaîne hexadécimale.
  • type (str) — Le type de l'événement.
  • created_at (datetime) — Un objet datetime contenant l’horodatage de création de l’événement.
  • author (str) — Nom d'utilisateur de l'auteur de la Discussion / Pull Request. Peut être "deleted" si l'utilisateur a été supprimé depuis.

Un événement dans une Discussion ou une Pull Request.

Utilisez des classes concrètes :

classe huggingface_hub.DiscussionComment

< >

( id: strtype: strcreated_at: datetimeauthor: str_event: dictcontent: stredited: boolhidden: bool )

Paramètres

  • id (str) — L'ID de l'événement. Une chaîne hexadécimale.
  • type (str) — Le type de l'événement.
  • created_at (datetime) — Un objet datetime contenant l’horodatage de création de l’événement.
  • author (str) — Nom d'utilisateur de l'auteur de la Discussion / Pull Request. Peut être "deleted" si l'utilisateur a été supprimé depuis.
  • content (str) — Le contenu Markdown brut du commentaire. Les mentions, les liens et les images ne sont pas rendus.
  • edited (bool) — Indique si ce commentaire a été modifié ou non.
  • hidden (bool) — Indique si ce commentaire a été masqué ou non.

Un commentaire dans une Discussion / Pull Request.

Sous-classe de DiscussionEvent.

classe huggingface_hub.DiscussionStatusChange

< >

( id: strtype: strcreated_at: datetimeauthor: str_event: dictnew_status: str )

Paramètres

  • id (str) — L'ID de l'événement. Une chaîne hexadécimale.
  • type (str) — Le type de l'événement.
  • created_at (datetime) — Un objet datetime contenant l’horodatage de création de l’événement.
  • author (str) — Nom d'utilisateur de l'auteur de la Discussion / Pull Request. Peut être "deleted" si l'utilisateur a été supprimé depuis.
  • new_status (str) — L'état de la Discussion / Pull Request après la modification. Il peut être l'un des suivants :
    • "open"
    • "closed"
    • "merged" (uniquement pour les Pull Requests)

Un changement de statut dans une Discussion / Pull Request.

Sous-classe de DiscussionEvent.

classe huggingface_hub.DiscussionCommit

< >

( id: strtype: strcreated_at: datetimeauthor: str_event: dictsummary: stroid: str )

Paramètres

  • id (str) — L'ID de l'événement. Une chaîne hexadécimale.
  • type (str) — Le type de l'événement.
  • created_at (datetime) — Un objet datetime contenant l’horodatage de création de l’événement.
  • author (str) — Nom d'utilisateur de l'auteur de la Discussion / Pull Request. Peut être "deleted" si l'utilisateur a été supprimé depuis.
  • summary (str) — Le résumé du commit.
  • oid (str) — L’OID / SHA de l’engagement, sous forme de chaîne hexadécimale.

Un commit dans une Pull Request.

Sous-classe de DiscussionEvent.

classe huggingface_hub.DiscussionTitleChange

< >

( id: strtype: strcreated_at: datetimeauthor: str_event: dictold_title: strnew_title: str )

Paramètres

  • id (str) — L'ID de l'événement. Une chaîne hexadécimale.
  • type (str) — Le type de l'événement.
  • created_at (datetime) — Un objet datetime contenant l’horodatage de création de l’événement.
  • author (str) — Nom d'utilisateur de l'auteur de la Discussion / Pull Request. Peut être "deleted" si l'utilisateur a été supprimé depuis.
  • old_title (str) — Le titre précédent de la Discussion / Pull Request.
  • new_title (str) — Le nouveau titre.

Un événement de renommage dans une Discussion / Pull Request.

Sous-classe de DiscussionEvent.

Update on GitHub

←Utilitaires Référence du système de cache→