Improve interface of list_packages

[mkoeppe]

(split out from #31013)

... representing package info using a new PackageInfo class, which provides also dict-like access, maintaining compatibility with the previous interface in this way.

CC: @jhpalmieri @dimpase

Component: misc

Author: Tobias Diez, Matthias Koeppe, John Palmieri

Branch: ebfb13c

Reviewer: Matthias Koeppe, John Palmieri, Tobias Diez

Issue created by migration from https://trac.sagemath.org/ticket/31385

[mkoeppe]

Branch: u/mkoeppe/improve_interface_of_list_packages

[mkoeppe]

Reviewer: Matthias Koeppe, ...

[mkoeppe]

Commit: 7488fcd

[mkoeppe]

Changed author from Tobias Diez to Tobias Diez, Matthias Koeppe

[mkoeppe]

New commits:

35642b3	sage.misc.packages, sage-list-packages: Use new class PackageInfo
687df80	sage.misc.package.PackageInfo: Improve wording of deprecation message, fix doctests
6bc70fc	sage.misc.package.list_packages: Align optional tags in doctests
7488fcd	Code cleanup

[mkoeppe]

comment:3

Sage development has entered the release candidate phase for 9.3. Setting a new milestone for this ticket based on a cursory review of ticket status, priority, and last modification date.

[tobiasdiez]

comment:4

Still needs review. Matthias, I'm happy with your changes - if that is sufficient, feel free to set it to positive review.

[dimpase]

comment:6

does not work with #31577 and #32036 - not sure which one to blame.

[jhpalmieri]

comment:8

Replying to @dimpase:

does not work with #31577 and #32036 - not sure which one to blame.

With this plus #32036, the Sage library fails to build for me:

Traceback (most recent call last):
  File "/Users/jpalmier/Desktop/Sage/sage_builds/TESTING/sage-9.4.beta3/build/pkgs/sagelib/src/setup.py", line 79, in <module>
    distributions += ['sage-{}'.format(pkg)
  File "/Users/jpalmier/Desktop/Sage/sage_builds/TESTING/sage-9.4.beta3/build/pkgs/sagelib/src/setup.py", line 81, in <listcomp>
    if is_package_installed_and_updated(pkg)]
  File "/Users/jpalmier/Desktop/Sage/sage_builds/TESTING/sage-9.4.beta3/build/pkgs/sagelib/src/sage_setup/optional_extension.py", line 51, in is_package_installed_and_updated
    condition = (pkginfo["installed_version"] == pkginfo["remote_version"])
  File "/Users/jpalmier/Desktop/Sage/sage_builds/TESTING/sage-9.4.beta3/build/pkgs/sagelib/src/sage/misc/package.py", line 210, in __getitem__
    from sage.misc.superseded import deprecation
  File "/Users/jpalmier/Desktop/Sage/sage_builds/TESTING/sage-9.4.beta3/build/pkgs/sagelib/src/sage/misc/superseded.py", line 29, in <module>
    from sage.misc.lazy_attribute import lazy_attribute
ModuleNotFoundError: No module named 'sage.misc.lazy_attribute'

(I don't think that #31577 is involved.)

[jhpalmieri]

comment:9

Replying to @jhpalmieri:

(I don't think that #31577 is involved.)

Or maybe it is, on another machine I'm seeing the same error with #31577 + #31385, but not #32036.

[jhpalmieri]

comment:10

Maybe these previous posts are red herrings, and the problem is this ticket doesn't work with the latest beta.

[mkoeppe]

comment:11

Thanks for testing it -- I'll revisit it after the next beta

[jhpalmieri]

comment:12

The following seems to fix it for me, but I don't know if it's a good and/or safe change:

diff --git a/src/sage_setup/optional_extension.py b/src/sage_setup/optional_extension.py
index 06586f1d39..f252849384 100644
--- a/src/sage_setup/optional_extension.py
+++ b/src/sage_setup/optional_extension.py
@@ -48,7 +48,7 @@ def is_package_installed_and_updated(pkg):
         # Might be an installed old-style package
         condition = is_package_installed(pkg)
     else:
-        condition = (pkginfo["installed_version"] == pkginfo["remote_version"])
+        condition = (pkginfo.installed_version == pkginfo.remote_version)
     return condition
 
 

[mkoeppe]

comment:13

Setting a new milestone for this ticket based on a cursory review.

[jhpalmieri]

Changed branch from u/mkoeppe/improve_interface_of_list_packages to u/jhpalmieri/improve_interface_of_list_packages

[jhpalmieri]

Changed commit from 7488fcd to ebfb13c

[jhpalmieri]

comment:15

If my changes are okay, then I think we should merge it.

---

New commits:

de1a48c	sage.misc.packages, sage-list-packages: Use new class PackageInfo
ebc4f82	sage.misc.package.PackageInfo: Improve wording of deprecation message, fix doctests
18bcf00	sage.misc.package.list_packages: Align optional tags in doctests
8b06dc8	Code cleanup
ebfb13c	trac 31385: fix sage_setup to use the new package attributes

[jhpalmieri]

Changed reviewer from Matthias Koeppe, ... to Matthias Koeppe, John Palmieri

[jhpalmieri]

Changed author from Tobias Diez, Matthias Koeppe to Tobias Diez, Matthias Koeppe, John Palmieri

[tobiasdiez]

comment:16

They are fine with me. Setting this to positive review as it seems that everyone reviewed everyone else's changes.

[tobiasdiez]

Changed reviewer from Matthias Koeppe, John Palmieri to Matthias Koeppe, John Palmieri, Tobias Diez

[mkoeppe]

comment:17

Yes, looks good to me. Thanks!

[vbraun]

Changed branch from u/jhpalmieri/improve_interface_of_list_packages to ebfb13c

[seblabbe]

comment:19

sage --standard, sage --optional and sage --experimental are broken in 9.5.beta6 (9 doctests failing in cmdline.py with --optional=sage,internet). Maybe this was caused by the changes made here. I created ticket #32885.

[seblabbe]

Changed commit from ebfb13c to none