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

Simplify python env markers #1967

Merged
merged 1 commit into from
Jul 27, 2023
Merged

Simplify python env markers #1967

merged 1 commit into from
Jul 27, 2023

Conversation

wagoodman
Copy link
Contributor

@wagoodman wagoodman commented Jul 27, 2023

This PR adjusts the python environment markers field in the PythonRequirementsMetadata to be a string instead of a map[string]string, thus requiring a breaking change to the JSON schema. Why do this? PEP 496 governs what can be expressed in environment markers. During the initial work it appeared that these could be simple key values (e.g. sys_platform == 'win32' -> sys_platform: win32) however the PEP makes clear that these case be arbitrary expressions python_version < '2.7.9' or (python_version >= '3.0' and python_version < '3.4'). For this reason the data shape has been relaxed to account for this.

@wagoodman wagoodman added the breaking-change Change is not backwards compatible label Jul 27, 2023
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
@wagoodman wagoodman force-pushed the simplify-python-env-markers branch from eb2c0e5 to acf8206 Compare July 27, 2023 14:04
@wagoodman
Copy link
Contributor Author

Schema diff for reviewers:

# $  diff -C 2 ./schema/json/schema-9.0.2.json ./schema/json/schema-10.0.0.json
*** ./schema/json/schema-9.0.2.json0.2.jThu Jul 27 08:55:01 2023-10.0.0.json
--- ./schema/json/schema-10.0.0.json    Thu Jul 27 10:04:40 2023
***************
*** 1,5 ****
  {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
!   "$id": "anchore.io/schema/syft/json/9.0.2/document",
    "$ref": "#/$defs/Document",
    "$defs": {
--- 1,5 ----
  {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
!   "$id": "anchore.io/schema/syft/json/10.0.0/document",
    "$ref": "#/$defs/Document",
    "$defs": {
***************
*** 1621,1630 ****
          },
          "markers": {
!           "patternProperties": {
!             ".*": {
!               "type": "string"
!             }
!           },
!           "type": "object"
          }
        },
--- 1621,1625 ----
          },
          "markers": {
!           "type": "string"
          }
        },

@wagoodman wagoodman self-assigned this Jul 27, 2023
@wagoodman wagoodman requested a review from a team July 27, 2023 14:07
@wagoodman wagoodman marked this pull request as ready for review July 27, 2023 14:07
@github-actions
Copy link

github-actions bot commented Jul 27, 2023

Benchmark Test Results

Benchmark results from the latest changes vs base branch
goos: linux%0Agoarch: amd64%0Apkg: github.com/anchore/syft/test/integration%0Acpu: Intel(R) Xeon(R) Platinum 8272CL CPU @ 2.60GHz%0A                                                              │ ./.tmp/benchmark-d0e077d.txt │%0A                                                              │            sec/op            │%0AImagePackageCatalogers/alpmdb-cataloger-2                                       12.33m ±  2%25%0AImagePackageCatalogers/apkdb-cataloger-2                                        738.1µ ±  4%25%0AImagePackageCatalogers/binary-cataloger-2                                       207.4µ ±  1%25%0AImagePackageCatalogers/dpkgdb-cataloger-2                                       617.4µ ±  2%25%0AImagePackageCatalogers/dotnet-portable-executable-cataloger-2                   22.38µ ±  3%25%0AImagePackageCatalogers/go-module-binary-cataloger-2                             97.36µ ±  2%25%0AImagePackageCatalogers/java-cataloger-2                                         13.85m ±  1%25%0AImagePackageCatalogers/graalvm-native-image-cataloger-2                         96.11µ ±  1%25%0AImagePackageCatalogers/javascript-package-cataloger-2                           396.7µ ±  2%25%0AImagePackageCatalogers/nix-store-cataloger-2                                    285.7µ ±  1%25%0AImagePackageCatalogers/php-composer-installed-cataloger-2                       827.3µ ±  1%25%0AImagePackageCatalogers/portage-cataloger-2                                      496.7µ ±  1%25%0AImagePackageCatalogers/python-package-cataloger-2                               3.501m ± 15%25%0AImagePackageCatalogers/r-package-cataloger-2                                    215.0µ ±  2%25%0AImagePackageCatalogers/rpm-db-cataloger-2                                       575.9µ ±  3%25%0AImagePackageCatalogers/ruby-gemspec-cataloger-2                                 949.1µ ±  1%25%0AImagePackageCatalogers/sbom-cataloger-2                                         121.5µ ±  1%25%0Ageomean                                                                         500.9µ%0A%0A                                                              │ ./.tmp/benchmark-d0e077d.txt │%0A                                                              │             B/op             │%0AImagePackageCatalogers/alpmdb-cataloger-2                                       5.118Mi ± 0%25%0AImagePackageCatalogers/apkdb-cataloger-2                                        204.9Ki ± 0%25%0AImagePackageCatalogers/binary-cataloger-2                                       30.19Ki ± 0%25%0AImagePackageCatalogers/dpkgdb-cataloger-2                                       168.9Ki ± 0%25%0AImagePackageCatalogers/dotnet-portable-executable-cataloger-2                   3.696Ki ± 0%25%0AImagePackageCatalogers/go-module-binary-cataloger-2                             9.906Ki ± 0%25%0AImagePackageCatalogers/java-cataloger-2                                         2.825Mi ± 0%25%0AImagePackageCatalogers/graalvm-native-image-cataloger-2                         8.594Ki ± 0%25%0AImagePackageCatalogers/javascript-package-cataloger-2                           94.21Ki ± 0%25%0AImagePackageCatalogers/nix-store-cataloger-2                                    49.14Ki ± 0%25%0AImagePackageCatalogers/php-composer-installed-cataloger-2                       186.7Ki ± 0%25%0AImagePackageCatalogers/portage-cataloger-2                                      120.0Ki ± 0%25%0AImagePackageCatalogers/python-package-cataloger-2                               1.003Mi ± 0%25%0AImagePackageCatalogers/r-package-cataloger-2                                    53.29Ki ± 0%25%0AImagePackageCatalogers/rpm-db-cataloger-2                                       180.9Ki ± 0%25%0AImagePackageCatalogers/ruby-gemspec-cataloger-2                                 144.1Ki ± 0%25%0AImagePackageCatalogers/sbom-cataloger-2                                         14.20Ki ± 0%25%0Ageomean                                                                         100.3Ki%0A%0A                                                              │ ./.tmp/benchmark-d0e077d.txt │%0A                                                              │          allocs/op           │%0AImagePackageCatalogers/alpmdb-cataloger-2                                        87.74k ± 0%25%0AImagePackageCatalogers/apkdb-cataloger-2                                         4.182k ± 0%25%0AImagePackageCatalogers/binary-cataloger-2                                         830.0 ± 0%25%0AImagePackageCatalogers/dpkgdb-cataloger-2                                        3.002k ± 0%25%0AImagePackageCatalogers/dotnet-portable-executable-cataloger-2                     132.0 ± 0%25%0AImagePackageCatalogers/go-module-binary-cataloger-2                               281.0 ± 0%25%0AImagePackageCatalogers/java-cataloger-2                                          39.88k ± 0%25%0AImagePackageCatalogers/graalvm-native-image-cataloger-2                           228.0 ± 0%25%0AImagePackageCatalogers/javascript-package-cataloger-2                            1.342k ± 0%25%0AImagePackageCatalogers/nix-store-cataloger-2                                      895.0 ± 0%25%0AImagePackageCatalogers/php-composer-installed-cataloger-2                        4.079k ± 0%25%0AImagePackageCatalogers/portage-cataloger-2                                       2.268k ± 0%25%0AImagePackageCatalogers/python-package-cataloger-2                                16.44k ± 0%25%0AImagePackageCatalogers/r-package-cataloger-2                                      929.0 ± 0%25%0AImagePackageCatalogers/rpm-db-cataloger-2                                        3.989k ± 0%25%0AImagePackageCatalogers/ruby-gemspec-cataloger-2                                  2.447k ± 0%25%0AImagePackageCatalogers/sbom-cataloger-2                                           394.0 ± 0%25%0Ageomean                                                                          2.051k

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change Change is not backwards compatible
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants