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.

Sign up for GitHub

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

Jump to bottom

Poetry 1.5.0 removes category field. #26

Closed
real-yfprojects opened this issue May 22, 2023 · 9 comments
Closed

Poetry 1.5.0 removes category field. #26

real-yfprojects opened this issue May 22, 2023 · 9 comments
Labels
bug Something isn't working

Comments

@real-yfprojects
Copy link
Contributor

With v1.5.0 poetry no longer writes a category field to poetry.lock.
This results in the following error:

Traceback (most recent call last):
  File "/home/user/.cache/pre-commit/repo6cjh4d2_/py_env-python3.8/bin/swp", line 8, in <module>
    sys.exit(main())
  File "/home/user/.cache/pre-commit/repo6cjh4d2_/py_env-python3.8/lib/python3.8/site-packages/sync_with_poetry/swp.py", line 170, in main
    retv |= sync_repos(filename, args.all, args.skip, args.config, mapping)
  File "/home/user/.cache/pre-commit/repo6cjh4d2_/py_env-python3.8/lib/python3.8/site-packages/sync_with_poetry/swp.py", line 99, in sync_repos
    poetry_items = PoetryItems(content["package"], all, skip, db)
  File "/home/user/.cache/pre-commit/repo6cjh4d2_/py_env-python3.8/lib/python3.8/site-packages/sync_with_poetry/swp.py", line 58, in __init__
    if ((not all) and package["category"] != "dev") or package["name"] in skip:
  File "/home/user/.cache/pre-commit/repo6cjh4d2_/py_env-python3.8/lib/python3.8/site-packages/tomlkit/items.py", line 1007, in __getitem__
    return self._value[key]
  File "/home/user/.cache/pre-commit/repo6cjh4d2_/py_env-python3.8/lib/python3.8/site-packages/tomlkit/container.py", line 553, in __getitem__
    raise NonExistentKey(key)
tomlkit.exceptions.NonExistentKey: 'Key "category" does not exist.'
@floatingpurr floatingpurr added bug Something isn't working good first issue Good for newcomers labels May 22, 2023
@floatingpurr
Copy link
Owner

Thank you @real-yfprojects for your notice. It looks like that poetry 1.5.0 relies on poetry-core 1.6.0 that deprecates Package.category.

I'm not using the newer versions of Poetry on a daily basis. AFAIU from the doc, now there's no way to infer whether the dependency is a "dev dependency" or not from the lock file. Now, this kind of info is managed by dependency groups in the toml file (I guess this holds since poetry 1.2.0).

As per the doc of poetry 1.5.0:

Poetry will slowly transition away from the dev-dependencies notation which will soon be deprecated, so it’s advised to migrate your existing development dependencies to the new group notation.

I'm open to discussions (and contributions) about it.

@real-yfprojects
Copy link
Contributor Author

AFAIU from the doc, now there's no way to infer whether the dependency is a "dev dependency" or not from the lock file.

Why do you need that in the first place?

@floatingpurr
Copy link
Owner

There's no hard need. It is just the current way used by swp to check if a package is a "dev dependency". The newer versions of poetry rely on the broader concept of dependency groups. The dependency group of each package has been abstracted away from poetry.lock. That's correct, IMO. However, this changes how this package has to check the dependency type.

@real-yfprojects
Copy link
Contributor Author

I mean why do you differentiate between dev and non dev dependencies? If it is used in .pre-commit-config.yaml it should be synced with poetry no matter what.

@floatingpurr
Copy link
Owner

floatingpurr commented May 22, 2023 •
edited
Loading

Oh, I'm sorry, I didn't get your question.

I introduced the --all option at the very beginning of the story of this package. It was supposed to be just a kind of a little optimization for going through the collection of PreCommitRepo objects. Indeed, in most cases, .pre-commit is used only with dev packages. Usually, your business packages are not part of the pre-commit process. But this is not a relevant (or even a good) design, even more so now with these changes introduced in poetry.

You are right, the quickest fix could by simply considering poetry.lock as a whole, without caring anymore about the package type.

@floatingpurr
Copy link
Owner

New release brach tracked in #27.

@real-yfprojects
Copy link
Contributor Author

👍 Thanks. I can do a quick review later this week if you like.

@floatingpurr
Copy link
Owner

floatingpurr commented May 24, 2023 via email •
edited
Loading

@floatingpurr
Copy link
Owner

Ok, the fix is ready to ship, baked in version 1.0.0.

floatingpurr added a commit that referenced this issue May 25, 2023
@floatingpurr
Merge pull request #27 from floatingpurr/1.0.0
97df834 
Release 1.0.0. Close #26
@floatingpurr floatingpurr removed the good first issue Good for newcomers label May 25, 2023
real-yfprojects referenced this issue Jun 8, 2023
@floatingpurr
Update readme
50ac768
floatingpurr added a commit that referenced this issue Jun 8, 2023
@floatingpurr
Modify README with a clearer note about #26
d431d77
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@floatingpurr @real-yfprojects