adapt code to new spdx-tools release #3173

meretp · 2022-12-08T12:43:14Z

With the new release, the checksum class has been renamed, the license class has been moved to its own file, and files are now only allowed at document level.

Signed-off-by: Meret Behrens meret.behrens@tngtech.com

Fixes #3172

Tasks

Reviewed contribution guidelines
PR is descriptively titled 📑 and links the original issue above 🔗
Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
Run tests locally to check for errors.
Commits are in uniquely-named feature branch and has no merge conflicts 📁

nicoweidner

Here are two more locations that probably need to be adapted:

scancode-toolkit/setup.cfg

Line 107 in 8f07fdf

spdx_tools >= 0.7.0a3

scancode-toolkit/setup-mini.cfg

Line 106 in 8f07fdf

spdx_tools >= 0.7.0a3

pombredanne · 2022-12-24T08:23:43Z

@meretp @nicoweidner I pushed spdx-tools 0.7.0rc0 so you should be able to update your PR accordingly.

meretp · 2022-12-28T10:45:59Z

@pombredanne I updated the PR accordingly and all tests pass now, so this is ready for review.

tests/formattedcode/test_output_spdx.py

armintaenzertng · 2022-12-30T10:42:45Z

I updated the requirement.txt files of all other nexB repositories that include the spdx-tools dependency to use 0.7.0rc0:
nexB/aboutcode-toolkit#515
nexB/container-inspector#49
nexB/fetchcode#87
nexB/debian-inspector#34
nexB/typecode#30
nexB/plugincode#8
nexB/commoncode#50
nexB/extractcode#45
nexB/purldb#16
All pipeline runs are green except for extractcode, but that seems to be a non-related problem with the typecode dependency that also appears on the main branch.

meretp · 2023-01-11T13:16:13Z

@pombredanne Gentle ping, is there anything else I can do to get this PR merged?
We would really like to have the 0.7.0 release on PyPi for tools-python, as the current release is still the release candidate.

pombredanne · 2023-01-17T07:43:00Z

Gentle ping, is there anything else I can do to get this PR merged?
We would really like to have the 0.7.0 release on PyPi for tools-python, as the current release is still the release candidate.

We are all good and this is being merged today

pombredanne

@meretp Thanks! see some review nitpickings for your consideration.

pombredanne · 2023-01-17T07:45:20Z

setup-mini.cfg

@@ -103,7 +103,7 @@ install_requires =
    pymaven_patch >= 0.2.8
    requests >= 2.7.0
    saneyaml >= 0.5.2
-    spdx_tools == 0.7.0a3
+    spdx_tools >= 0.7.0rc0, ==0.7.*


We avoid using upper cap in setup requirements. We pin instead in requirements files.

Suggested change

spdx_tools >= 0.7.0rc0, ==0.7.*

spdx_tools >= 0.7.0rc0

See https://iscinumpy.dev/post/bound-version-constraints/ and https://caremad.io/posts/2013/07/setup-vs-requirement/ for detailed articles on the topics. ScanCode is both used as an app and as a library. App deps are pinned, library deps are not capped.

Since there is currently a big refactoring in the progress, which is breaking the API after 0.7, we think that it is safer to restrict it here. Otherwise we will run into the same race condition with releasing.

Pinning in requirement files was not sufficient to mitigate the breaking changes between 0.7.0a3 and 0.7.0rc0.

setup.cfg

src/formattedcode/output_spdx.py

tests/formattedcode/test_output_spdx.py

pombredanne · 2023-01-17T07:53:19Z

@meretp @maxhbr tell me who needs to own the PyPI account (I need to know the PyPI user id so I can send the invites)

maxhbr · 2023-01-17T08:09:55Z

@meretp @maxhbr tell me who needs to own the PyPI account (I need to know the PyPI user id so I can send the invites)

My account on pypi is maxhbr.

With the new release, the checksum class has been renamed, the license class has been moved to its own file, and files are now only allowed at document level. Signed-off-by: Meret Behrens <meret.behrens@tngtech.com>

Signed-off-by: Meret Behrens <meret.behrens@tngtech.com>

meretp · 2023-01-17T14:01:42Z

@pombredanne I included your suggested changes in a fix-up commit to squash this before merging. Two tests fail but that seems to be another issue as the latest commit on develop also has these failing tests.
Regarding the comments in setup.cfg: as @maxhbr commented we would really appreciate if we could avoid another race condition with releasing for the changes to come in tools-python.

pombredanne · 2023-01-18T00:17:30Z

Regarding the comments in setup.cfg: as @maxhbr commented we would really appreciate if we could avoid another race condition with releasing for the changes to come in tools-python.

No worries, we will be fine now!

pombredanne

The test failure is unrelated and fixed in develop. I still prefer a pinned SPDX version for now.

setup-mini.cfg

setup.cfg

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

pombredanne

Thanks! The code looks good and the failure is fixed in develop.
I can merge as is!
I fixed the requirements to be pinned for SPDX tools for now as I do not like stars.

nicoweidner reviewed Dec 8, 2022

View reviewed changes

meretp force-pushed the python_tools_release branch 2 times, most recently from 50a1233 to 0efa0ff Compare December 28, 2022 10:16

maxhbr reviewed Dec 28, 2022

View reviewed changes

tests/formattedcode/test_output_spdx.py Show resolved Hide resolved

pombredanne mentioned this pull request Jan 2, 2023

Errors due to new update in spdx-tools==0.7.0rc0 nexB/scancode.io#577

Closed

pombredanne added this to the v32.0 milestone Jan 6, 2023

AyanSinhaMahapatra mentioned this pull request Jan 9, 2023

The following plugin(s) are referenced and cannot be loaded/imported: scancodeio-worker-1 | cannot import name 'Algorithm' from 'spdx.checksum' (/usr/local/lib/python3.9/site-packages/spdx/checksum.py) nexB/scancode.io#582

Closed

pombredanne requested changes Jan 17, 2023

View reviewed changes

meretp added 3 commits January 17, 2023 10:28

adapt code to new spdx-tools release

d89ab65

With the new release, the checksum class has been renamed, the license class has been moved to its own file, and files are now only allowed at document level. Signed-off-by: Meret Behrens <meret.behrens@tngtech.com>

exclude license list version from comparison of tv-files

a000d7c

Signed-off-by: Meret Behrens <meret.behrens@tngtech.com>

fixup! adapt code to new spdx-tools release

5c7c4a8

Signed-off-by: Meret Behrens <meret.behrens@tngtech.com>

meretp force-pushed the python_tools_release branch from 0a1774e to 5c7c4a8 Compare January 17, 2023 09:46

pombredanne reviewed Jan 18, 2023

View reviewed changes

setup-mini.cfg Outdated Show resolved Hide resolved

setup.cfg Outdated Show resolved Hide resolved

Pin spdx_tools

4677510

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

pombredanne force-pushed the python_tools_release branch from b51387d to 4677510 Compare January 18, 2023 00:26

pombredanne requested changes Jan 18, 2023

View reviewed changes

pombredanne approved these changes Jan 18, 2023

View reviewed changes

pombredanne merged commit caec256 into nexB:develop Jan 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adapt code to new spdx-tools release #3173

adapt code to new spdx-tools release #3173

meretp commented Dec 8, 2022 •

edited

Loading

nicoweidner left a comment

pombredanne commented Dec 24, 2022

meretp commented Dec 28, 2022

armintaenzertng commented Dec 30, 2022

meretp commented Jan 11, 2023

pombredanne commented Jan 17, 2023

pombredanne left a comment

pombredanne Jan 17, 2023

maxhbr Jan 17, 2023

pombredanne commented Jan 17, 2023

maxhbr commented Jan 17, 2023

meretp commented Jan 17, 2023

pombredanne commented Jan 18, 2023

pombredanne left a comment

pombredanne left a comment

adapt code to new spdx-tools release #3173

adapt code to new spdx-tools release #3173

Conversation

meretp commented Dec 8, 2022 • edited Loading

Tasks

nicoweidner left a comment

Choose a reason for hiding this comment

pombredanne commented Dec 24, 2022

meretp commented Dec 28, 2022

armintaenzertng commented Dec 30, 2022

meretp commented Jan 11, 2023

pombredanne commented Jan 17, 2023

pombredanne left a comment

Choose a reason for hiding this comment

pombredanne Jan 17, 2023

Choose a reason for hiding this comment

maxhbr Jan 17, 2023

Choose a reason for hiding this comment

pombredanne commented Jan 17, 2023

maxhbr commented Jan 17, 2023

meretp commented Jan 17, 2023

pombredanne commented Jan 18, 2023

pombredanne left a comment

Choose a reason for hiding this comment

pombredanne left a comment

Choose a reason for hiding this comment

meretp commented Dec 8, 2022 •

edited

Loading