Skip to content

fix/add allow_unsafe_* params in docstrings + fix typo #1530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion git/objects/submodule/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,9 @@ def _clone_repo(
:param url: url to clone from
:param path: repository - relative path to the submodule checkout location
:param name: canonical of the submodule
:param kwrags: additinoal arguments given to git.clone"""
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:param allow_unsafe_options: Allow unsafe options to be used, like --upload-pack
:param kwargs: additional arguments given to git.clone"""
module_abspath = cls._module_abspath(repo, path, name)
module_checkout_path = module_abspath
if cls._need_gitfile_submodules(repo.git):
Expand Down Expand Up @@ -411,6 +413,8 @@ def add(
as its value.
:param clone_multi_options: A list of Clone options. Please see ``git.repo.base.Repo.clone``
for details.
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:param allow_unsafe_options: Allow unsafe options to be used, like --upload-pack
:return: The newly created submodule instance
:note: works atomically, such that no change will be done if the repository
update fails for instance"""
Expand Down Expand Up @@ -581,6 +585,8 @@ def update(
as its value.
:param clone_multi_options: list of Clone options. Please see ``git.repo.base.Repo.clone``
for details. Only take effect with `init` option.
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:param allow_unsafe_options: Allow unsafe options to be used, like --upload-pack
:note: does nothing in bare repositories
:note: method is definitely not atomic if recurisve is True
:return: self"""
Expand Down
9 changes: 9 additions & 0 deletions git/remote.py
Original file line number Diff line number Diff line change
Expand Up @@ -641,6 +641,7 @@ def set_url(

:param new_url: string being the URL to add as an extra remote URL
:param old_url: when set, replaces this URL with new_url for the remote
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:return: self
"""
if not allow_unsafe_protocols:
Expand All @@ -660,6 +661,7 @@ def add_url(self, url: str, allow_unsafe_protocols: bool = False, **kwargs: Any)
multiple URLs for a single remote.

:param url: string being the URL to add as an extra remote URL
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:return: self
"""
return self.set_url(url, add=True, allow_unsafe_protocols=allow_unsafe_protocols)
Expand Down Expand Up @@ -760,6 +762,7 @@ def create(cls, repo: "Repo", name: str, url: str, allow_unsafe_protocols: bool
:param repo: Repository instance that is to receive the new remote
:param name: Desired name of the remote
:param url: URL which corresponds to the remote's name
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:param kwargs: Additional arguments to be passed to the git-remote add command
:return: New Remote instance
:raise GitCommandError: in case an origin with that name already exists"""
Expand Down Expand Up @@ -978,6 +981,8 @@ def fetch(
:param kill_after_timeout:
To specify a timeout in seconds for the git command, after which the process
should be killed. It is set to None by default.
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:param allow_unsafe_options: Allow unsafe options to be used, like --upload-pack
:param kwargs: Additional arguments to be passed to git-fetch
:return:
IterableList(FetchInfo, ...) list of FetchInfo instances providing detailed
Expand Down Expand Up @@ -1027,6 +1032,8 @@ def pull(
:param refspec: see :meth:`fetch` method
:param progress: see :meth:`push` method
:param kill_after_timeout: see :meth:`fetch` method
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:param allow_unsafe_options: Allow unsafe options to be used, like --upload-pack
:param kwargs: Additional arguments to be passed to git-pull
:return: Please see :meth:`fetch` method"""
if refspec is None:
Expand Down Expand Up @@ -1077,6 +1084,8 @@ def push(
:param kill_after_timeout:
To specify a timeout in seconds for the git command, after which the process
should be killed. It is set to None by default.
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:param allow_unsafe_options: Allow unsafe options to be used, like --receive-pack
:param kwargs: Additional arguments to be passed to git-push
:return:
A ``PushInfoList`` object, where each list member
Expand Down
6 changes: 4 additions & 2 deletions git/repo/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1259,7 +1259,8 @@ def clone(
option per list item which is passed exactly as specified to clone.
For example ['--config core.filemode=false', '--config core.ignorecase',
'--recurse-submodule=repo1_path', '--recurse-submodule=repo2_path']
:param unsafe_protocols: Allow unsafe protocols to be used, like ext
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:param allow_unsafe_options: Allow unsafe options to be used, like --upload-pack
:param kwargs:
* odbt = ObjectDatabase Type, allowing to determine the object database
implementation used by the returned Repo instance
Expand Down Expand Up @@ -1302,7 +1303,8 @@ def clone_from(
If you want to unset some variable, consider providing empty string
as its value.
:param multi_options: See ``clone`` method
:param unsafe_protocols: Allow unsafe protocols to be used, like ext
:param allow_unsafe_protocols: Allow unsafe protocols to be used, like ext
:param allow_unsafe_options: Allow unsafe options to be used, like --upload-pack
:param kwargs: see the ``clone`` method
:return: Repo instance pointing to the cloned directory"""
git = cls.GitCommandWrapperType(os.getcwd())
Expand Down