Deprecate (mark for future removal) get_pkg_version from the public API

[noklam]

Context

          @merelcht It didn't change by #3742. 

kedro/kedro/framework/cli/utils.py

Lines 204 to 218 in a91ccdb

	def get_pkg_version(reqs_path: (str | Path), package_name: str) -> str:
	"""Get package version from requirements.txt.
	Args:
	reqs_path: Path to requirements.txt file.
	package_name: Package to search for.
	Returns:
	Package and its version as specified in requirements.txt.
	Raises:
	KedroCliError: If the file specified in ``reqs_path`` does not exist
	or ``package_name`` was not found in that file.
	"""
	reqs_path = Path(reqs_path).absolute()

I just check again, this function is not used anywhere in framework, but only tests. (last change is 4 years ago). Maybe at some points it was used for kedro build-reqs? I suggest we deprecate this function since it's a public function and move it to test.

Originally posted by @noklam in #2912 (comment)

Remove the function from public API and move it to test only.

[noklam]

One question here, we tend to do the breaking change later in develop to avoid the code diverge too much. At the same time should we add the deprecated warnings earlier in 0.19 to inform user?

This is not important for this particular issue, because I think no one use it (hopefully), but it is a valid question for what should we do in general?

[astrojuanlu]

should we add the deprecated warnings earlier in 0.19 to inform user?

Yes

[noklam]

Do we need a subticket for deprecation? Or this is ready to go in backlog grooming.

…

On Thu, 11 Apr 2024, 15:32 Juan Luis Cano Rodríguez, < ***@***.***> wrote: should we add the deprecated warnings earlier in 0.19 to inform user? Yes — Reply to this email directly, view it on GitHub <#3789 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AELAWL6RQQZNPW2IXZXHCFDY42NJXAVCNFSM6AAAAABF4VKBCOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANBZHAZTINBQGE> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[astrojuanlu]

I'd say let's rename this ticket to "Deprecate get_pkg_version" and groom it

[noklam]

Actually the tests are obsoleted and we should remove it altogether class TestCliUtils in test_cli.py.

[astrojuanlu]

Funny bit of insight found in the source code of kedro-mlflow:

            # if it is a local relative path, make it absolute
            # .resolve() does not work well on windows
            # .absolute is undocumented and have known bugs
            # Path.cwd() / uri is the recommend way by core developpers.
            # See : https://discuss.python.org/t/pathlib-absolute-vs-resolve/2573/6

Not sure how up to date it is though (the thread is from 2019).