Skip to content
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

Update docs and add deprecation warning for lock -r #5069

Merged
merged 3 commits into from
Apr 30, 2022

Conversation

ImreC
Copy link
Contributor

@ImreC ImreC commented Apr 22, 2022

@matteius I gave pipenv lock -r some more thought and I think we should over time deprecate it in favor of pipenv requirements. This PR contains a deprecation warning and an update to the docs. Please let me know your thoughts

echo(
crayons.yellow(
"""
Warning: The lock flags -r/--requirements, along with it's options (--keep-outdated, --dev, --dev-only)
Copy link
Member

@matteius matteius Apr 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you cannot deprecate --keep-outdated because it is used to change the behavior of locking and thus install as well. I think the --dev or --dev-only may also be used similarly .. isn't --dev how you specify to only install the development requirements? I am not sure about --dev-only actually.

Otherwise I think this is the right direction to head in.

Unrelated, can you also have a look at this PR: #5071

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh one more thing, we are trying to not add any more crayons usage -- use click coloring instead. @oz123 will thank you. I have a recent example of doing just that: https://github.com/pypa/pipenv/pull/5046/files#diff-ef852c4ac364f946819f765a6bc26f04f1b0968f31fc512949a60fa2ab0685e8R903-R910

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does requirements subcommand updates the packages? Is the default keep-outdated or update?
This should be clarified in the deperecation message.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the message. It indeed was very confusing. Apologies. Please check if it is okay now @matteius @oz123

@oz123
Copy link
Contributor

oz123 commented Apr 30, 2022

@ImreC thank you for this contribution!

@oz123 oz123 merged commit 6e26552 into pypa:main Apr 30, 2022
jeffwidman added a commit to dependabot/dependabot-core that referenced this pull request Aug 8, 2023
In the versions between what we are currently on in `dependaobt-core`
and the latest versions of `pipenv`, they deprecated and then completely
removed the `pipenv lock [-d]` command in favor of `pipenv requirements
[--dev]` command.

Since our current version of `pipenv` supports the `pipenv requirements`
command, let's proactively switch to it now. That will make the future
upgrade in #7715
easier.

More context:
* pypa/pipenv#5069
* pypa/pipenv#5091
* pypa/pipenv#5198
* pypa/pipenv#5200
jeffwidman added a commit to dependabot/dependabot-core that referenced this pull request Aug 8, 2023
In the versions between what we are currently on in `dependaobt-core`
and the latest versions of `pipenv`, they deprecated and then completely
removed the `pipenv lock [-d]` command in favor of `pipenv requirements
[--dev]` command.

Since our current version of `pipenv` supports the `pipenv requirements`
command, let's proactively switch to it now. That will make the future
upgrade in #7715
easier.

More context:
* pypa/pipenv#5069
* pypa/pipenv#5091
* pypa/pipenv#5198
* pypa/pipenv#5200
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants