sage.env: Remove direct uses of SAGE_LOCAL from the Sage library

[mkoeppe]

(from #31338 comment:13)

These changes are preparation for modularization and is also intended to make downstream packaging easier.

CC: @kiwifb @antonio-rojas @dimpase @videlec @jhpalmieri

Component: build: configure

Author: Matthias Koeppe, François Bissey

Branch/Commit: 985af6e

Reviewer: Dima Pasechnik, François Bissey

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

[mkoeppe]

comment:1

There are a few remaining uses of SAGE_SHARE in src/sage that will have to be eliminated though.

[mkoeppe]

comment:2

(see #30819 sage.databases: Use sage.feature to define database file system location)

[mkoeppe]

comment:3

Perhaps now is also the time that we do #30914 (Meta-ticket: Create upstream repositories, pip-installable packages for database packages)?

[kiwifb]

comment:4

Replying to @mkoeppe:

Perhaps now is also the time that we do #30914 (Meta-ticket: Create upstream repositories, pip-installable packages for database packages)?

That would be timely if we could.

Other issue about sage_setup/setenv.py I tried to replace if SAGE_LOCAL: by if SAGE_ROOT: since it is set to None for me in distro. But I still got the linking noise which means that it still accepted that as a positive. So a better test may be needed.

[mkoeppe]

comment:5

No, SAGE_ROOT is not the right choice there.

[kiwifb]

comment:6

Replying to @kiwifb:

Other issue about sage_setup/setenv.py I tried to replace if SAGE_LOCAL: by if SAGE_ROOT: since it is set to None for me in distro. But I still got the linking noise which means that it still accepted that as a positive. So a better test may be needed.

Scratch that, I think I did myself in at build time for some reasons (which I have top check).

[mkoeppe]

Branch: u/mkoeppe/sage_env__remove_default_setting_of_sage_local_from_sage_venv

[mkoeppe]

Commit: 95deabd

[mkoeppe]

New commits:

95deabd

src/sage/env.py: No fallback for SAGE_LOCAL

[mkoeppe]

Author: Matthias Koeppe

[antonio-rojas]

comment:9

> sage
Traceback (most recent call last):
  File "/usr/bin/sage-ipython", line 9, in <module>
    from sage.misc.banner import banner
  File "/usr/lib/python3.9/site-packages/sage/misc/banner.py", line 16, in <module>
    from sage.env import (SAGE_VERSION, SAGE_VERSION_BANNER, SAGE_BANNER)
  File "/usr/lib/python3.9/site-packages/sage/env.py", line 314, in <module>
    SINGULAR_SO = var("SINGULAR_SO", _get_shared_lib_path("Singular", "singular-Singular"))
  File "/usr/lib/python3.9/site-packages/sage/env.py", line 291, in _get_shared_lib_path
    search_directories = [Path(SAGE_LOCAL) / 'lib']
  File "/usr/lib/python3.9/pathlib.py", line 1072, in __new__
    self = cls._from_parts(args, init=False)
  File "/usr/lib/python3.9/pathlib.py", line 697, in _from_parts
    drv, root, parts = self._parse_args(args)
  File "/usr/lib/python3.9/pathlib.py", line 681, in _parse_args
    a = os.fspath(a)
TypeError: expected str, bytes or os.PathLike object, not NoneType

[sagetrac-git]

Changed commit from 95deabd to de66da4

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

de66da4

sage.env._get_shared_lib_path: If SAGE_LOCAL is not set, skip it

[mkoeppe]

comment:11

Thanks for catching this!

[antonio-rojas]

comment:12

Next issue:

/usr/lib/python3.9/site-packages/sage/interfaces/gap_workspace.py in gap_workspace_file(system='gap', name='workspace', dir='/home/antonio/.sage/gap')
     [...]
     57         sage: assert name1 == name2
     58     """
     59     if dir is None:
     60         dir = os.path.join(DOT_SAGE, 'gap')
     61 
---> 62     h = hashlib.sha1(SAGE_LOCAL.encode('utf-8')).hexdigest()
        h = undefined
        global hashlib.sha1 = <built-in function openssl_sha1>
        global SAGE_LOCAL.encode.hexdigest = undefined
     63     return os.path.join(dir, '%s-%s-%s' % (system, name, h))
     64 
     65 
AttributeError: 'NoneType' object has no attribute 'encode'

and, after bypassing it

/usr/lib/python3.9/site-packages/sage/interfaces/lie.py in __init__(self=LiE Interpreter, maxread=None, script_subdirectory=None, logfile=None, server=None)
    [...]
    329                         # it to be very obfuscated that would be better.   Even
    330                         # better is to use sequence numbers.
    331                         prompt = '> ',
    332 
    333                         # This is the command that starts up your program
--> 334                         command = "bash "+ SAGE_LOCAL + "/bin/lie",
        global command = undefined
        global SAGE_LOCAL = None
    335 
    336                         server=server,
    337                         script_subdirectory = script_subdirectory,
    338 

TypeError: can only concatenate str (not "NoneType") to str