o h@sddlZddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z m Z m Z mZmZmZmZmZddlmZddlmZddlmZmZdd lmZmZdd lmZdd lm Z m!Z!m"Z"m#Z#m$Z$m%Z%dd l&m'Z'e"(e)Z*Gd ddZ+dee,e fde-fddZ.dee,e fde,de-fddZ/dee,e fde-fddZ0dee,e fde-fddZ1dee,e fde-fddZ2d,de,dee,e dfdee,fdd Z3dee,e fde-fd!d"Z4d-dee,e fd#ee,de5fd$d%Z6Gd&d'd'eZ7ed(d)Z8Gd*d+d+Z9dS).N)contextmanager)Path)CallableDictIteratorListOptionalTuple TypedDictUnion)urlparse) constants) metadata_load metadata_save)HfApirepo_type_and_id_from_hf_id)LFS_MULTIPART_UPLOAD_COMMAND)SoftTemporaryDirectory get_tokenloggingrun_subprocesstqdmvalidate_hf_hub_args)_deprecate_methodc @seZdZdZ ddedededejdeef dd Z e d e fd d Z e d e fd dZe d e fddZe d efddZe d efddZddZdS)CommandInProgressz= Utility to follow commands launched asynchronously. Ntitleis_done_method status_methodprocess post_methodcCs.||_||_||_||_d|_d|_||_dS)N)r_is_done_status_process_stderr_stdout _post_method)selfrrrrr r)n/var/www/html/construction_image-detection-poc/venv/lib/python3.10/site-packages/huggingface_hub/repository.py__init__$s zCommandInProgress.__init__returncCs(|}|r|jdur|d|_|S)z. Whether the process is done. N)r"r')r(resultr)r)r*is_done4s zCommandInProgress.is_donecCs|S)z The exit code/status of the current action. Will return `0` if the command has completed successfully, and a number between 1 and 255 if the process errored-out. Will return -1 if the command is still ongoing. )r#r(r)r)r*statusAs zCommandInProgress.statuscCs |jdkS)z2 Whether the process errored-out. rr0r/r)r)r*failedLs zCommandInProgress.failedcC(|jjdur|j|jj7_|jS)zC The current output message on the standard error. N)r$stderrr%readr/r)r)r*r4S zCommandInProgress.stderrcCr3)zD The current output message on the standard output. N)r$stdoutr&r5r/r)r)r*r7\r6zCommandInProgress.stdoutc Cs@|j}|dkr d}d|jd|d|jsdndd|jjd S) Nrunning[z command, status code: z, z in progress.z finished.z PID: ])r0rr.r$pid)r(r0r)r)r*__repr__es zCommandInProgress.__repr__N)__name__ __module__ __qualname____doc__strr subprocessPopenrr+propertyboolr.intr0r2r4r7r=r)r)r)r*rs2     rfolderr,cCs>tjtj|d}tjd|tjtjd}|o|jdkS)a Check if the folder is the root or part of a git repository Args: folder (`str`): The folder in which to run the command. Returns: `bool`: `True` if the repository is part of a repository, `False` otherwise. z.gitz git branch)cwdr7r4r) ospathexistsjoinrDrunsplitPIPE returncode)rI folder_exists git_branchr)r)r* is_git_repors rU remote_urlcCs@t|sdStd|j}tdd|}dd|D}||vS)am Check if the folder is a local clone of the remote_url Args: folder (`str` or `Path`): The folder in which to run the command. remote_url (`str`): The url of a git repository. Returns: `bool`: `True` if the repository is a local clone of the remote repository specified, `False` otherwise. Fz git remote -v https://.*@https://cSsg|] }tdd|qS)rWrX)resub).0remoter)r)r* z"is_local_clone..)rUrr7rYrZrP)rIrVremotesr)r)r*is_local_clones  r`filenamec Cst|j}t|j}ztd|g|}|j}Wntjy8}zt |s/WYd}~dSt |j d}~wwt |dkrAdSdddd}|dD]}| D]}||vr`d|vr`d||<qRqLt|S) z Check if the file passed is tracked with git-lfs. Args: filename (`str` or `Path`): The filename to check. Returns: `bool`: `True` if the file passed is tracked with git-lfs, `False` otherwise. zgit check-attr -aNFr)diffmergefilter lfsT)rparentnamerrPr7striprDCalledProcessErrorrUOSErrorr4lenkeysallvalues)rarIp attributesexc found_lfs_tag attributetagr)r)r*is_tracked_with_lfss*      rvc Csdt|j}t|j}ztd|g|dd}t|j }W|Stjy1}zt |j d}~ww)a Check if file is git-ignored. Supports nested .gitignore files. Args: filename (`str` or `Path`): The filename to check. Returns: `bool`: `True` if the file passed is ignored by `git`, `False` otherwise. zgit check-ignoreFcheckN) rrgrhrrPrGrRrDrjrkr4)rarIrp is_ignoredrrr)r)r*is_git_ignoreds  rzcCs|z3t|d }|d}Wdn1swYthdttdddhB}t|d|WSty=YdSw) z Check if file is a binary file. Args: filename (`str` or `Path`): The filename to check. Returns: `bool`: `True` if the file passed is a binary file, `False` otherwise. rbiN>  T)openr5 bytearraysetrangerG translateUnicodeDecodeError)rafcontent text_charsr)r)r*is_binary_files    r.patternc Cshz!td|g|}t|jr|jd}W|Sg}W|Stjy3}zt|jd}~ww)aQ Returns a list of filenames that are to be staged. Args: pattern (`str` or `Path`): The pattern of filenames to check. Put `.` to get all files. folder (`str` or `Path`): The folder in which to run the command. Returns: `List[str]`: List of files that are to be staged. z#git ls-files --exclude-standard -moreN) rrPrlr7rirDrjEnvironmentErrorr4)rrIrpfilesrrr)r)r*files_to_be_stageds  rc CsLztd|WdStjy%}zd|jvrtdWYd}~dSd}~ww)a Check if the current checked-out branch is tracked upstream. Args: folder (`str` or `Path`): The folder in which to run the command. Returns: `bool`: `True` if the current checked-out branch is tracked upstream, `False` otherwise. z4git rev-parse --symbolic-full-name --abbrev-ref @{u}THEADzNo branch checked outNF)rrDrjr4rk)rIrrr)r)r*is_tracked_upstream s  rupstreamc CsPztd|pd|}t|jddWStjy'}zt|jd}~ww)a Check the number of commits that would be pushed upstream Args: folder (`str` or `Path`): The folder in which to run the command. upstream (`str`, *optional*): The name of the upstream repository with which the comparison should be made. Returns: `int`: Number of commits that would be pushed upstream were a `git push` to proceed. zgit cherry -v r!rerN)rrlr7rPrDrjrr4)rIrr-rrr)r)r*commits_to_push s rc@seZdZUeed<eed<dS)PbarTbar past_bytesN)r?r@rAr__annotations__rHr)r)r)r*r6s  rc cs ttjkrzdVWdStyYdSwdtjfdd}tj dd}t P}tj |dtjd<t dtjdt}tj||fd d }|zdVW|| |tjd<n|| |tjd<wWddS1s~wYdS) zv This is a context manager that will log the Git LFS progress of cleaning, smudging, pulling and pushing. Nstopping_eventc sLifdddttffdd }tjtjds4r&dStdtjtjdr|tjdD]h}z | \}}}}Wnt y[}zt d ||d}~ww| d |}| d \} } t | } t | }  ||f} | durt|| | d d dddt | d||f<q;| d| | d| | d<q;dS)zl To be launched as a separate thread with an event meaning it should stop the tail. csFD]}|d|dj|d|d|dqdS)Nrr)roupdatetotalrefreshclose)pbar)pbarsr)r* close_pbarsRs  z?_lfs_log_progress..output_progress..close_pbarsr,c3st|d9}d} rn%|}|dur1t|dks1||7}|dr0|Vd}ntdq WddS1sBwYdS)z Creates a generator to be iterated through, which will return each line one by one. Will stop tailing the file if the stopping_event is set. rr!TNrrer)ris_setreadlinerlriendswithtimesleep)rafile current_lineline_bit)rrr)r* tail_fileXs$   "z=_lfs_log_progress..output_progress..tail_fileGIT_LFS_PROGRESSNz!Cannot unpack LFS progress line: z file /BTizhuggingface_hub.lfs_upload)descinitialrunit unit_scale unit_divisorrh)rrrr)rrCrKrLrMenvironrrrrP ValueError capitalizerHgetrr)rrlinestate file_progress byte_progressraerror description current_bytes total_bytescurrent_bytes_inttotal_bytes_intrr))rrrr*output_progressJsH    z*_lfs_log_progress..output_progressrr! lfs_progresszFollowing progress in T)targetargsdaemon)loggergetEffectiveLevelrERROR Exception threadingEventrKrrrrLrNdebugThreadstartr)rcurrent_lfs_progress_valuetmpdir exit_eventxr)r)r*_lfs_log_progress<s4 M "rc@sDeZdZUdZeeed<eeddd        dhd e e e fd e e d e e d e e e fd e e de e de e de de efddZede fddZddZedide d e e e dffddZdjd e e de e fddZddZde fd d!Zde fd"d#Zde fd$d%Zdee fd&d'Zdkd(e e ee fd)e fd*d+Zd(e e ee ffd,d-Zd.d/Zdld1e dee fd2d3Zdld1e dee fd4d5Zdkd6d7Zdmd8e d9e fd:d;Z dnd1e dZ!dod@e fdAdBZ"   dpdCe e dDe dEe de e e#e efffdFdGZ$dkde dHe fdIdJZ%didKe dLe e de fdMdNZ&didKe dLe e de fdOdPZ'djdKe dQe e dLe e fdRdSZ(de fdTdUZ) ?   dqd@e dDe dVe dEe de de e#e efff dWdXZ*e+    drd@e dYe e dZe dDe dEe f d[d\Z,de e-fd]d^Z.d_e-ddfd`daZ/edbdcZ0edddeZ1dfdgZ2dS)s RepositoryaR Helper class to wrap the git and git-lfs commands. The aim is to facilitate interacting with huggingface.co hosted model or dataset repos, though not a lot here (if any) is actually specific to huggingface.co. [`Repository`] is deprecated in favor of the http-based alternatives implemented in [`HfApi`]. Given its large adoption in legacy code, the complete removal of [`Repository`] will only happen in release `v1.0`. For more details, please read https://huggingface.co/docs/huggingface_hub/concepts/git_vs_http. command_queuez1.0zPlease prefer the http-based alternatives instead. Given its large adoption in legacy code, the complete removal is only planned on next major release. For more details, please read https://huggingface.co/docs/huggingface_hub/concepts/git_vs_http.)versionmessageNTF local_dir clone_from repo_typetokengit_user git_emailrevisionskip_lfs_filesclientc Cs^t|tr t|}tj|ddtjt||_||_ g|_ ||_ | dur)| nt |_ |t|tr:||_n |durBd|_nt|_|durQ|j|dnt|jr\tdntd|jdur|dusm|dur|j |j} |dur}| d}|dur| d }|dus|dur||||||dur|j|dd t|jdS) a Instantiate a local clone of a git repo. If `clone_from` is set, the repo will be cloned from an existing remote repository. If the remote repo does not exist, a `EnvironmentError` exception will be thrown. Please create the remote repo first using [`create_repo`]. `Repository` uses the local git credentials by default. If explicitly set, the `token` or the `git_user`/`git_email` pair will be used instead. Args: local_dir (`str` or `Path`): path (e.g. `'my_trained_model/'`) to the local directory, where the `Repository` will be initialized. clone_from (`str`, *optional*): Either a repository url or `repo_id`. Example: - `"https://huggingface.co/philschmid/playground-tests"` - `"philschmid/playground-tests"` repo_type (`str`, *optional*): To set when cloning a repo from a repo_id. Default is model. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. git_user (`str`, *optional*): will override the `git config user.name` for committing and pushing files to the hub. git_email (`str`, *optional*): will override the `git config user.email` for committing and pushing files to the hub. revision (`str`, *optional*): Revision to checkout after initializing the repository. If the revision doesn't exist, a branch will be created with that revision name from the default branch's current HEAD. skip_lfs_files (`bool`, *optional*, defaults to `False`): whether to skip git-LFS files or not. client (`HfApi`, *optional*): Instance of [`HfApi`] to use when calling the HF Hub API. A new instance will be created if this is left to `None`. Raises: [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) If the remote repository set in `clone_from` does not exist. T)exist_okNF)repo_urlz [Repository] is a valid git repozNIf not specifying `clone_from`, you need to pass Repository a valid git clone.emailfullnamecreate_branch_ok) isinstancerrCrKmakedirsrLrNgetcwdr _repo_typerrrrcheck_git_versionshuggingface_tokenrrrUrrrwhoamirgit_config_username_and_emaillfs_enable_largefilesgit_credential_helper_store git_checkoutatexitregisterwait_for_commands) r(rrrrrrrrruserr)r)r*r+s@ C      zRepository.__init__r,c Cs>z td|jj}W|Stjy}zt|jd}~ww)zz Returns the current checked out branch. Returns: `str`: Current checked out branch. zgit rev-parse --abbrev-ref HEADNrrr7rirDrjrr4)r(r-rrr)r)r*current_branch3s zRepository.current_branchcCsrz td|jj}Wn tytdwz td|jj}Wn ty-tdwt|d|dS)z Checks that `git` and `git-lfs` can be run. Raises: [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) If `git` or `git-lfs` are not installed. z git --versionz9Looks like you do not have git installed, please install.zgit-lfs --versionzLooks like you do not have git-lfs installed, please install. You can install from https://git-lfs.github.com/. Then run `git lfs install` (you only have to do this once).reN)rrr7riFileNotFoundErrorrrinfo)r( git_version lfs_versionr)r)r*rBs  zRepository.check_git_versionsrc Cs|t|tr|n|dur dn|j}|dur|drtd|jj}||vs2d|vr}t|ddkr}t ||d\}}}|durF|d|n|}|durO||_ |d}|j t j vra|t j |j 7}|duryt |j}||d |d |d }||7}td d |} ztd|jtt|jdkrtd| dt*tj} |jr| ddit|jrdndd|d|j| dWdn 1swYWdSWdSt|jstd|jd|jdt|j|rt|jd| dWdStd|jdd} d | d!| d"} | j dkr'td#d$| j!} | d%| 7} t| t"j#y=}zt|j$d}~ww)&a Clone from a remote. If the folder already exists, will try to clone the repository within it. If this folder is a git repository with linked history, will try to update the repository. Args: repo_url (`str`): The URL from which to clone the repository token (`Union[str, bool]`, *optional*): Whether to use the authentication token. It can be: - a string which is the token itself - `False`, which would not use the authentication token - `True`, which would fetch the authentication token from the local folder and use it (you should be logged in for this to work). - `None`, which would retrieve the value of `self.huggingface_token`. Raises the following error: - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if an organization token (starts with "api_org") is passed. Use must use your own personal access token (see https://hf.co/settings/tokens). - [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) if you are trying to clone the repository in a non-empty folder, or if the `git` operations raise errors. FNapi_orgzgYou must use your personal access token, not an Organization token (see https://hf.co/settings/tokens).httprr)hub_urlz://z://user:@z(https?)://.*@z\1://zgit lfs installrzCloning z into local empty directory.GIT_LFS_SKIP_SMUDGE1z git clonez git lfs clone z .)envzPTried to clone a repository in a non-empty folder that isn't a git repository ('z7'). If you really want to do this, do it manually: cd z && git init && git remote add origin && git pull origin main or clone repo to a new folder and move your existing files there afterwards.z is already a clone of z?. Make sure you pull the latest changes with `repo.git_pull()`.zgit remote get-url originrwzTried to clone zn in an unrelated git repository. If you believe this is an error, please add a remote with the following URL: rrWrXz' Local path has its origin defined as: )%rrCr startswithrrendpointrlrPrrr REPO_TYPES_URL_PREFIXESr schemereplacerYrZrrrKlistdirrwarningrrcopyrrrUrr`rRr7rDrjr4)r(rrrr namespace repo_namerepo_idr clean_repo_urlroutput error_msgclean_local_remote_urlrrr)r)r*rYs~& "    (     zRepository.clone_fromc Csnz$|durtd|g|j|dur"td||jWdSWdStjy6}zt|jd}~ww)a Sets git username and email (only in the current repo). Args: git_user (`str`, *optional*): The username to register through `git`. git_email (`str`, *optional*): The email to register through `git`. Nzgit config user.namezgit config user.email )rrPrrDrjrr4)r(rrrrr)r)r*rs  z(Repository.git_config_username_and_emailc Cs8z td|jWdStjy}zt|jd}~ww)z; Sets the git credential helper to `store` z"git config credential.helper storeN)rrrDrjrr4)r(rrr)r)r*rs  z&Repository.git_credential_helper_storec Cs>z td|j}|jWStjy}zt|jd}~ww)zy Get commit sha on top of HEAD. Returns: `str`: The current checked out commit SHA. zgit rev-parse HEADNr)r(rprrr)r)r* git_head_hashs   zRepository.git_head_hashc CsLztd|j}|j}tdd|WStjy%}zt|j d}~ww)zp Get URL to origin remote. Returns: `str`: The URL of the `origin` remote. z"git config --get remote.origin.urlrWrXN) rrr7rirYrZrDrjrr4)r(rpurlrrr)r)r*git_remote_urls   zRepository.git_remote_urlcCs4|}|}|dr|dd}|d|S)z Get URL to last commit on HEAD. We assume it's been pushed, and the url scheme is the same one as for GitHub or HuggingFace. Returns: `str`: The URL to the current checked-out commit. rNr8z/commit/)rrr)r(sharr)r)r*git_head_commit_urls   zRepository.git_head_commit_urlc Csz td|jj}Wntjy}zt|jd}~wwt|dkr&gSdd| dD}dd|D}dd|D}|S) z Returns a list of the files that are deleted in the working directory or index. Returns: `List[str]`: A list of files that have been deleted in the working directory or index. z git status -sNrcSsg|]}|qSr))rir[r0r)r)r*r]8sz1Repository.list_deleted_files..recSs g|] }d|dvr|qS)Dr)rPrr)r)r*r];s cSsg|] }|dqS)r8)rPrirr)r)r*r]>s rrr7rirDrjrr4rlrP)r( git_statusrrmodified_files_statusesdeleted_files_statuses deleted_filesr)r)r*list_deleted_filess    zRepository.list_deleted_filespatternsrac Csft|tr|g}z|D]}td|rdndd||jq WdStjy2}zt|jd}~ww)a9 Tell git-lfs to track files according to a pattern. Setting the `filename` argument to `True` will treat the arguments as literal filenames, not as patterns. Any special glob characters in the filename will be escaped when writing to the `.gitattributes` file. Args: patterns (`Union[str, List[str]]`): The pattern, or list of patterns, to track with git-lfs. filename (`bool`, *optional*, defaults to `False`): Whether to use the patterns as literal filenames. zgit lfs track z --filenamer!rN)rrCrrrDrjrr4)r(r%rarrrr)r)r* lfs_trackBs  zRepository.lfs_trackc Cs\t|tr|g}z|D] }td|g|jq WdStjy-}zt|jd}~ww)z Tell git-lfs to untrack those files. Args: patterns (`Union[str, List[str]]`): The pattern, or list of patterns, to untrack with git-lfs. zgit lfs untrackN) rrCrrPrrDrjrr4)r(r%rrrr)r)r* lfs_untrack[s  zRepository.lfs_untrackc CsXzd}t|d|jt|dt|jWdStjy+}zt|jd}~ww)zI HF-specific. This enables upload support of files >5GB. z'git config lfs.customtransfer.multipartz.path huggingface-cliz.args N)rrrrDrjrr4)r( lfs_configrrr)r)r*rks   z Repository.lfs_enable_largefilesrrcCsg}|}t||jdD];}||vrq tjt|j|}t|sHt|sHtj |d}|dkr8t dt |}|rH| |||q |||S)aH Automatically track binary files with git-lfs. Args: pattern (`str`, *optional*, defaults to "."): The pattern with which to track files that are binary. Returns: `List[str]`: List of filenames that are now tracked due to being binary files rIrzParsing a large file to check if binary or not. Tracking large files using `repository.auto_track_large_files` is recommended so as to not load the full file in memory.)r$rrrKrLrNrrvrzgetsizerrrr&appendr')r(rfiles_to_be_tracked_with_lfsr#ra path_to_file size_in_mb is_binaryr)r)r*auto_track_binary_filesys&    z"Repository.auto_track_binary_filescCsg}|}t||jdD]0}||vrq tjt|j|}tj|d}|dkr=t|s=t |s=| || |q | ||S)ap Automatically track large files (files that weigh more than 10MBs) with git-lfs. Args: pattern (`str`, *optional*, defaults to "."): The pattern with which to track files that are above 10MBs. Returns: `List[str]`: List of filenames that are now tracked due to their size. r)r*r) r$rrrKrLrNrr+rvrzr&r,r')r(rr-r#rar.r/r)r)r*auto_track_large_filess    z!Repository.auto_track_large_filesc Cs|z+ttd|r dnd|j}t|jWdWdS1s$wYWdStjy=}zt|j d}~ww)a git lfs prune Args: recent (`bool`, *optional*, defaults to `False`): Whether to prune files even if they were referenced by recent commits. See the following [link](https://github.com/git-lfs/git-lfs/blob/f3d43f0428a84fc4f1e5405b76b5a73ec2437e65/docs/man/git-lfs-prune.1.ronn#recent-files) for more information. zgit lfs prune z--recentr!N rrrrrr7rDrjrr4)r(recentr-rrr)r)r* lfs_prunes & zRepository.lfs_prunerebaserfc Cs|sdnd}|r |d7}z$tt||j}t|jWdWdS1s)wYWdStjyB}zt|j d}~ww)a7 git pull Args: rebase (`bool`, *optional*, defaults to `False`): Whether to rebase the current branch on top of the upstream branch after fetching. lfs (`bool`, *optional*, defaults to `False`): Whether to fetch the LFS files too. This option only changes the behavior when a repository was cloned without fetching the LFS files; calling `repo.git_pull(lfs=True)` will then fetch the LFS file from the remote repository. zgit pullz git lfs pullz --rebaseNr3)r(r6rfcommandr-rrr)r)r*git_pulls  & zRepository.git_pullauto_lfs_trackc Cs|r||}||||rtd|dztd|g|j}td|j dWdSt j yD}zt |j d}~ww)a7 git add Setting the `auto_lfs_track` parameter to `True` will automatically track files that are larger than 10MB with `git-lfs`. Args: pattern (`str`, *optional*, defaults to "."): The pattern with which to add files to staging. auto_lfs_track (`bool`, *optional*, defaults to `False`): Whether to automatically track large and binary files with git-lfs. Any file over 10MB in size, or in binary format, will be automatically tracked. z!Adding files tracked by Git LFS: z5. This may take a bit of time if the files are large.z git add -vzAdding to index: reN)r2extendr1rrrrPrrr7rDrjrr4)r(rr9 tracked_filesr-rrr)r)r*git_adds   zRepository.git_addcommit files to HF hubcommit_messagec Csnztd|g|j}td|jdWdStjy6}zt|j dkr-t |j t |jd}~ww)z git commit Args: commit_message (`str`, *optional*, defaults to "commit files to HF hub"): The message attributed to the commit. zgit commit -v -mz Committed: rerN) rrPrrrr7rDrjrlr4r)r(r>r-rrr)r)r* git_commits  zRepository.git_commitrblockingauto_lfs_prunec sbd}|r |d|7}t|j|}|dkr%td|d|r%tdzIt<tj|tjtjd|jd|r^ \}} } t |rRt||r^tj |j||d Wd n1shwYWntj y} zt| jd } ~ ww|sfd d } td fdd| |r|jnd d} |j| || fS|r||S)a% git push If used without setting `blocking`, will return url to commit on remote repo. If used with `blocking=True`, will return a tuple containing the url to commit and the command object to follow for information about the process. Args: upstream (`str`, *optional*): Upstream to which this should push. If not specified, will push to the lastly defined upstream or to the default one (`origin main`). blocking (`bool`, *optional*, defaults to `True`): Whether the function should return only when the push has finished. Setting this to `False` will return an `CommandInProgress` object which has an `is_done` property. This property will be set to `True` when the push is finished. auto_lfs_prune (`bool`, *optional*, defaults to `False`): Whether to automatically prune files once they have been pushed to the remote. zgit pushz --set-upstream rzSeveral commits (z) will be pushed upstream.z$The progress bars may be unreliable.zutf-8)r4r7encodingrJ)rr4Ncs}|dur dS|S)Nr8pollr1rr)r*rdsz*Repository.git_push..status_methodpushcs duSr>rCr)rEr)r*ms z%Repository.git_push..)rrrr )rrrrrrDrErPrQ communicaterDkillrlrjrrr4rr5rr,r) r(rr@rAr7number_of_commitsr7r4 return_coderrrcommand_in_progressr)rEr*git_push"s\          zRepository.git_pushrc Csztd||j}td|d|jdt|jWd Stjyj}z>|s/t|j ztd||j}td|d|dt|jWntjy^}zt|j d }~wwWYd }~d Sd }~ww) a git checkout a given revision Specifying `create_branch_ok` to `True` will create the branch to the given revision if that revision doesn't exist. Args: revision (`str`): The revision to checkout. create_branch_ok (`str`, *optional*, defaults to `False`): Whether creating a branch named with the `revision` passed at the current checked-out reference if `revision` isn't an existing revision is allowed. z git checkout z Checked out z from rzgit checkout -b z Revision `z2` does not exist. Created and checked out branch `z`.N) rrrrrr7rDrjrr4)r(rrr-rrr)r)r*r|s(  zRepository.git_checkouttag_namer\c Cs|r)ztd||jj}Wntjy"}zt|jd}~wwt|dkSz td|jj}WntjyF}zt|jd}~ww| d}||vS)aw Check if a tag exists or not. Args: tag_name (`str`): The name of the tag to check. remote (`str`, *optional*): Whether to check if the tag exists on a remote. This parameter should be the identifier of the remote. Returns: `bool`: Whether the tag exists. zgit ls-remote origin refs/tags/Nrzgit tagrer)r(rNr\r-rrgit_tagsr)r)r* tag_existss     zRepository.tag_existsc Csd}d}||s d}|j||dsd}|r8ztddd|g|jjWntjy7}zt|jd}~ww|ra|raztd|d ||jjWdStjy`}zt|jd}~wwdS) a Delete a tag, both local and remote, if it exists Args: tag_name (`str`): The tag name to delete. remote (`str`, *optional*): The remote on which to delete the tag. Returns: `bool`: `True` if deleted, `False` if the tag didn't exist. If remote is not passed, will just be updated locally TF)r\gitruz-dN git push z --delete ) rPrrr7rirDrjrr4)r(rNr\delete_locallydelete_remotelyrrr)r)r* delete_tags,    zRepository.delete_tagrc Cs|r ddd|d|g}ndd|g}z t||jjWntjy-}zt|jd}~ww|rUztd|d||jjWdStjyT}zt|jd}~wwdS)a[ Add a tag at the current head and push it If remote is None, will just be updated locally If no message is provided, the tag will be lightweight. if a message is provided, the tag will be annotated. Args: tag_name (`str`): The name of the tag to be added. message (`str`, *optional*): The message that accompanies the tag. The tag will turn into an annotated tag if a message is passed. remote (`str`, *optional*): The remote on which to add the tag. rQruz-az-mNrRrr)r(rNrr\tag_argsrrr)r)r*add_tags"  $ zRepository.add_tagc CsHz td|jj}Wntjy}zt|jd}~wwt|dkS)z Return whether or not the git status is clean or not Returns: `bool`: `True` if the git status is clean, `False` otherwise. zgit status --porcelainNr) rrr7rirDrjrr4rl)r(r rrr)r)r* is_repo_cleans  zRepository.is_repo_cleanclean_okcCsH|r |r tddS|jdd|||jd|j||dS)aF Helper to add, commit, and push files to remote repository on the HuggingFace Hub. Will automatically track large files (>10MB). Args: commit_message (`str`): Message to use for the commit. blocking (`bool`, *optional*, defaults to `True`): Whether the function should return only when the `git push` has finished. clean_ok (`bool`, *optional*, defaults to `True`): If True, this function will return None if the repo is untouched. Default behavior is to fail because the git command fails. auto_lfs_prune (`bool`, *optional*, defaults to `False`): Whether to automatically prune files once they have been pushed to the remote. z*Repo currently clean. Ignoring push_to_hubNTr9origin rr@rA)rXrrr<r?rMr)r(r>r@rYrAr)r)r* push_to_hubs     zRepository.push_to_hubbranchtrack_large_filesc cs,td|jd}t|r-t|dkr t|dddddnt|}td|d|dur8|j|d d t|jrItd |j d d n td |j dt }t t j||jz[|VW|j|dz||Wnty} zdt| vr| WYd} ~ nd} ~ wwz|jd|j ||dWnty} z dt| vrtd| | d} ~ wwt |dS|j|dz||Wnty} zdt| vr| WYd} ~ nd} ~ wwz|jd|j ||dWnty} zdt| vr td| | d} ~ wwt |w)a Context manager utility to handle committing to a repository. This automatically tracks large files (>10Mb) with git-lfs. Set the `track_large_files` argument to `False` if you wish to ignore that behavior. Args: commit_message (`str`): Message to use for the commit. branch (`str`, *optional*): The branch on which the commit will appear. This branch will be checked-out before any operation. track_large_files (`bool`, *optional*, defaults to `True`): Whether to automatically track large files or not. Will do so by default. blocking (`bool`, *optional*, defaults to `True`): Whether the function should return only when the `git push` has finished. auto_lfs_prune (`bool`, defaults to `True`): Whether to automatically prune files once they have been pushed to the remote. Examples: ```python >>> with Repository( ... "text-files", ... clone_from="/text-files", ... token=True, >>> ).commit("My first file :)"): ... with open("file.txt", "w+") as f: ... f.write(json.dumps({"hey": 8})) >>> import torch >>> model = torch.nn.Transformer() >>> with Repository( ... "torch-model", ... clone_from="/torch-model", ... token=True, >>> ).commit("My cool model :)"): ... torch.save(model.state_dict(), "model.pt") ``` rr)Nr8z, ...]zPThere exists some updated files in the local repository that are not committed: z|. This may lead to errors if checking out a branch. These files and their modifications will be added to the current commit.TrzPulling changes ...)r6z@The current branch has no upstream branch. Will push to 'origin 'rZznothing to commitr[r\zcould not read UsernamezCCouldn't authenticate user for push. Did you set `token` to `True`?)rrrlrCrrrrrr8rrKrchdirrLrNr<r?rkrM) r(r>r^r_r@rAfiles_to_stage files_in_msgcurrent_working_directoryer)r)r*commit3s~70                zRepository.commitcCs*tj|jtj}tj|rt|SdSr>)rKrLrNrr REPOCARD_NAMEisfiler)r(filepathr)r)r*repocard_metadata_loads z!Repository.repocard_metadata_loaddatacCsttj|jtj|Sr>)rrKrLrNrr rh)r(rlr)r)r*repocard_metadata_savesz!Repository.repocard_metadata_savecCdd|jDS)z@ Returns the asynchronous commands that failed. cSsg|] }|jdkr|qS)rr1r[cr)r)r*r]r^z.Repository.commands_failed..rr/r)r)r*commands_failedzRepository.commands_failedcCrn)zS Returns the asynchronous commands that are currently in progress. cSsg|]}|js|qSr))r.ror)r)r*r]sz3Repository.commands_in_progress..rqr/r)r)r*commands_in_progressrszRepository.commands_in_progresscCsd}|jD]}td|jd|jjdt|jq|jr>|ddkr0td|jd|d7}t d|js d Sd S) zr Blocking method: blocks all subsequent execution until all commands have been processed. rzThe z command with PID z failed.rzCWaiting for the following commands to finish before shutting down: rrN) rrrrrr$r<r4rtrrr)r(indexcommand_failedr)r)r*rs    zRepository.wait_for_commands)NNTNNNFNr>)NN)F)r)FF)rF)r=)NTF)r=TTF)NTTF)3r?r@rArBrrrrrr rCrrrGrr+rFrrrrrrrrr$r&r'rr1r2r5r8r<r?r rMrrPrUrWrXr]rrgrrkrmrrrtrr)r)r)r*rs       l    #+ !" Z  %" $ h   r)rNr>):rrKrYrDrr contextlibrpathlibrtypingrrrrrr r r urllib.parser huggingface_hubr huggingface_hub.repocardrrhf_apirrrfrutilsrrrrrrutils._deprecationr get_loggerr?rrrCrGrUr`rvrzrrrrHrrrrr)r)r)r*s<  (      S%&$ m