fix(cli): remove deprecated `--all` option in favor of `--get-all` · python-gitlab/python-gitlab@e9d48cf · GitHub

1. python-gitlab
2. python-gitlab

Repository navigation

• Code
• Issues16 (16)
• Pull requests15 (15)
• Discussions
• Actions
• Projects
• Security and quality
• Insights

Commit e9d48cf

Browse filesBrowse the repository at this point in the historyBrowse files

nejch

authored and

JohnVillalovos

committed

fix(cli): remove deprecated --all option in favor of --get-all

BREAKING CHANGE: The `--all` option is no longer available in the CLI. Use `--get-all` instead.

1 parent d054917 commit e9d48cf
Copy full SHA for e9d48cf

4 files changed

+11-8Lines changed: 11 additions & 8 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• docs
  • faq.rst
• gitlab/v4
  • cli.py
  • objects
    • commits.py
• tests/functional/cli
  • test_cli_repository.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎docs/faq.rst‎

Copy file name to clipboardExpand all lines: docs/faq.rst

+1-1Lines changed: 1 addition & 1 deletion

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -42,7 +42,7 @@ Example::
42	42	Not all items are returned from the API
43	43	"""""""""""""""""""""""""""""""""""""""
44	44
45		- If you've passed ``all=True`` (or ``--all`` via the CLI) to the API and still cannot see all items returned,
	45	+ If you've passed ``all=True`` to the API and still cannot see all items returned,
46	46	use ``get_all=True`` (or ``--get-all`` via the CLI) instead. See :ref:`pagination` for more details.
47	47
48	48	Common errors

Collapse file

‎gitlab/v4/cli.py‎

Copy file name to clipboardExpand all lines: gitlab/v4/cli.py

-6Lines changed: 0 additions & 6 deletions

Original file line number	Diff line number	Diff line change
@@ -236,12 +236,6 @@ def _populate_sub_parser_by_class(
236	236	action="store_true",
237	237	help="Return all items from the server, without pagination.",
238	238	)
239		- sub_parser_action.add_argument(
240		- "--all",
241		- required=False,
242		- action="store_true",
243		- help="Deprecated. Use --get-all instead.",
244		- )
245	239
246	240	if action_name == "delete":
247	241	if cls._id_attr is not None:

Collapse file

‎gitlab/v4/objects/commits.py‎

Copy file name to clipboardExpand all lines: gitlab/v4/objects/commits.py

+1Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -155,6 +155,7 @@ class ProjectCommitManager(RetrieveMixin, CreateMixin, RESTManager):
155	155	optional=("author_email", "author_name"),
156	156	)
157	157	_list_filters = (
	158	+ "all",
158	159	"ref_name",
159	160	"since",
160	161	"until",

Collapse file

‎tests/functional/cli/test_cli_repository.py‎

Copy file name to clipboardExpand all lines: tests/functional/cli/test_cli_repository.py

+9-1Lines changed: 9 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -43,7 +43,15 @@ def test_list_all_commits(gitlab_cli, project):
43	43	assert commit.id not in ret.stdout
44	44
45	45	# Listing commits on other branches requires `all` parameter passed to the API
46		- cmd = ["project-commit", "list", "--project-id", project.id, "--get-all", "--all"]
	46	+ cmd = [
	47	+ "project-commit",
	48	+ "list",
	49	+ "--project-id",
	50	+ project.id,
	51	+ "--get-all",
	52	+ "--all",
	53	+ "true",
	54	+ ]
47	55	ret_all = gitlab_cli(cmd)
48	56	assert commit.id in ret_all.stdout
49	57	assert len(ret_all.stdout) > len(ret.stdout)

0 commit comments

Comments

0 (0)