U diM0@sdZddlmZddlmZddlmZmZmZmZm Z ddl m Z ddl m Z edZeGd d d ZeGd d d eZGd ddeZeGdddZeGdddeZeGdddeZeGdddeZeGdddeZeedddZdS)a Data structures to interact with Discussions and Pull Requests on the Hub. See [the Discussions and Pull Requests guide](https://huggingface.co/docs/hub/repositories-pull-requests-discussions) for more information on Pull Requests, Discussions, and the community tab. ) dataclass)datetime)ListLiteralOptional TypedDictUnion) constants)parse_datetime)openclosedmergedZdraftc@seZdZUdZeed<eed<eed<eed<eed<eed<eed<e ed <eed <e e ed d d Z e ed ddZ dS) Discussiona A Discussion or Pull Request on the Hub. This dataclass is not intended to be instantiated directly. Attributes: title (`str`): The title of the Discussion / Pull Request status (`str`): The status of the Discussion / Pull Request. It must be one of: * `"open"` * `"closed"` * `"merged"` (only for Pull Requests ) * `"draft"` (only for Pull Requests ) num (`int`): The number of the Discussion / Pull Request. repo_id (`str`): The id (`"{namespace}/{repo_name}"`) of the repo on which the Discussion / Pull Request was open. repo_type (`str`): The type of the repo on which the Discussion / Pull Request was open. Possible values are: `"model"`, `"dataset"`, `"space"`. author (`str`): The username of the Discussion / Pull Request author. Can be `"deleted"` if the user has been deleted since. is_pull_request (`bool`): Whether or not this is a Pull Request. created_at (`datetime`): The `datetime` of creation of the Discussion / Pull Request. endpoint (`str`): Endpoint of the Hub. Default is https://huggingface.co. git_reference (`str`, *optional*): (property) Git reference to which changes can be pushed if this is a Pull Request, `None` otherwise. url (`str`): (property) URL of the discussion on the Hub. titlestatusnumrepo_id repo_typeauthoris_pull_request created_atendpointreturncCs|jrd|jSdS)z If this is a Pull Request , returns the git reference to which changes can be pushed. Returns `None` otherwise. zrefs/pr/N)rrselfr=/tmp/pip-unpacked-wheel-ohruig0i/huggingface_hub/community.py git_referenceEs zDiscussion.git_referencecCsR|jdks|jtjkr0|jd|jd|jS|jd|jd|jd|jS)z-Returns the URL of the discussion on the Hub.N/z /discussions/zs/)rr ZREPO_TYPE_MODELrrrrrrrurlOszDiscussion.urlN)__name__ __module__ __qualname____doc__str__annotations__DiscussionStatusintboolrpropertyrrr!rrrrrs & rc@sXeZdZUdZeded<eeeedfed<e eed<e eed<e eed<dS) DiscussionWithDetailsa7 Subclass of [`Discussion`]. Attributes: title (`str`): The title of the Discussion / Pull Request status (`str`): The status of the Discussion / Pull Request. It can be one of: * `"open"` * `"closed"` * `"merged"` (only for Pull Requests ) * `"draft"` (only for Pull Requests ) num (`int`): The number of the Discussion / Pull Request. repo_id (`str`): The id (`"{namespace}/{repo_name}"`) of the repo on which the Discussion / Pull Request was open. repo_type (`str`): The type of the repo on which the Discussion / Pull Request was open. Possible values are: `"model"`, `"dataset"`, `"space"`. author (`str`): The username of the Discussion / Pull Request author. Can be `"deleted"` if the user has been deleted since. is_pull_request (`bool`): Whether or not this is a Pull Request. created_at (`datetime`): The `datetime` of creation of the Discussion / Pull Request. events (`list` of [`DiscussionEvent`]) The list of [`DiscussionEvents`] in this Discussion or Pull Request. conflicting_files (`Union[List[str], bool, None]`, *optional*): A list of conflicting files if this is a Pull Request. `None` if `self.is_pull_request` is `False`. `True` if there are conflicting files but the list can't be retrieved. target_branch (`str`, *optional*): The branch into which changes are to be merged if this is a Pull Request . `None` if `self.is_pull_request` is `False`. merge_commit_oid (`str`, *optional*): If this is a merged Pull Request , this is set to the OID / SHA of the merge commit, `None` otherwise. diff (`str`, *optional*): The git diff if this is a Pull Request , `None` otherwise. endpoint (`str`): Endpoint of the Hub. Default is https://huggingface.co. git_reference (`str`, *optional*): (property) Git reference to which changes can be pushed if this is a Pull Request, `None` otherwise. url (`str`): (property) URL of the discussion on the Hub. DiscussionEventeventsNZconflicting_filesZ target_branchZmerge_commit_oidZdiff) r"r#r$r%rr'rr&r*rrrrrr,Ws 2   r,c@s6eZdZUeed<eed<eed<eed<eed<dS)DiscussionEventArgsidtyperr_eventN)r"r#r$r&r'rdictrrrrr/s r/c@s:eZdZUdZeed<eed<eed<eed<eed<dS)r-a An event in a Discussion or Pull Request. Use concrete classes: * [`DiscussionComment`] * [`DiscussionStatusChange`] * [`DiscussionCommit`] * [`DiscussionTitleChange`] Attributes: id (`str`): The ID of the event. An hexadecimal string. type (`str`): The type of the event. created_at (`datetime`): A [`datetime`](https://docs.python.org/3/library/datetime.html?highlight=datetime#datetime.datetime) object holding the creation timestamp for the event. author (`str`): The username of the Discussion / Pull Request author. Can be `"deleted"` if the user has been deleted since. r0r1rrr2N)r"r#r$r%r&r'rr3rrrrr-s r-c@seZdZUdZeed<eed<eed<eedddZee ddd Z eedd d Z ee e dd d ZeedddZdS)DiscussionCommentazA comment in a Discussion / Pull Request. Subclass of [`DiscussionEvent`]. Attributes: id (`str`): The ID of the event. An hexadecimal string. type (`str`): The type of the event. created_at (`datetime`): A [`datetime`](https://docs.python.org/3/library/datetime.html?highlight=datetime#datetime.datetime) object holding the creation timestamp for the event. author (`str`): The username of the Discussion / Pull Request author. Can be `"deleted"` if the user has been deleted since. content (`str`): The raw markdown content of the comment. Mentions, links and images are not rendered. edited (`bool`): Whether or not this comment has been edited. hidden (`bool`): Whether or not this comment has been hidden. contenteditedhiddenrcCs|jdddS)z&The rendered comment, as a HTML stringdatalatesthtmlr2rrrrrenderedszDiscussionComment.renderedcCst|jdddS)+The last edit time, as a `datetime` object.r8r9Z updatedAt)r r2rrrrlast_edited_atsz DiscussionComment.last_edited_atcCs|jdddiddS)r=r8r9rnamedeleted)r2getrrrrlast_edited_bysz DiscussionComment.last_edited_bycCs|jddS)zThe edit history of the commentr8historyr;rrrr edit_historyszDiscussionComment.edit_historycCs t|jS)N)lenrDrrrrnumber_of_editssz!DiscussionComment.number_of_editsN)r"r#r$r%r&r'r*r+r<rr>rBrr3rDr)rFrrrrr4s r4c@seZdZUdZeed<dS)DiscussionStatusChangeaVA change of status in a Discussion / Pull Request. Subclass of [`DiscussionEvent`]. Attributes: id (`str`): The ID of the event. An hexadecimal string. type (`str`): The type of the event. created_at (`datetime`): A [`datetime`](https://docs.python.org/3/library/datetime.html?highlight=datetime#datetime.datetime) object holding the creation timestamp for the event. author (`str`): The username of the Discussion / Pull Request author. Can be `"deleted"` if the user has been deleted since. new_status (`str`): The status of the Discussion / Pull Request after the change. It can be one of: * `"open"` * `"closed"` * `"merged"` (only for Pull Requests ) new_statusNr"r#r$r%r&r'rrrrrGs rGc@s"eZdZUdZeed<eed<dS)DiscussionCommitaA commit in a Pull Request. Subclass of [`DiscussionEvent`]. Attributes: id (`str`): The ID of the event. An hexadecimal string. type (`str`): The type of the event. created_at (`datetime`): A [`datetime`](https://docs.python.org/3/library/datetime.html?highlight=datetime#datetime.datetime) object holding the creation timestamp for the event. author (`str`): The username of the Discussion / Pull Request author. Can be `"deleted"` if the user has been deleted since. summary (`str`): The summary of the commit. oid (`str`): The OID / SHA of the commit, as a hexadecimal string. summaryoidNrIrrrrrJs rJc@s"eZdZUdZeed<eed<dS)DiscussionTitleChangeaA rename event in a Discussion / Pull Request. Subclass of [`DiscussionEvent`]. Attributes: id (`str`): The ID of the event. An hexadecimal string. type (`str`): The type of the event. created_at (`datetime`): A [`datetime`](https://docs.python.org/3/library/datetime.html?highlight=datetime#datetime.datetime) object holding the creation timestamp for the event. author (`str`): The username of the Discussion / Pull Request author. Can be `"deleted"` if the user has been deleted since. old_title (`str`): The previous title for the Discussion / Pull Request. new_title (`str`): The new title. old_title new_titleNrIrrrrrM)s rM)eventrcCs|d}|d}t|d}||||didd|d}|dkrvtf||d d |d d |d d d dS|dkrtf|d|d diS|dkrtf||d d|d ddS|dkrtf||d d|d ddStf|S)z.Instantiates a [`DiscussionEvent`] from a dictr0r1Z createdAtrr?r@)r0r1rrr2commentr8r6r7r9raw)r6r7r5z status-changerHrcommitsubjectrL)rKrLz title-changefromto)rNrO)r rAr4rGrJrMr-)rPZevent_idZ event_typerZ common_argsrrrdeserialize_eventDsF         rWN)r%Z dataclassesrrtypingrrrrrr utilsr r(rr,r/r-r4rGrJrMr3rWrrrrs,    C: 6