sage.repl: Replace use of SAGE_EXTCODE by importlib.resources

[mkoeppe]

We eliminate direct reading of files from the package directories of sagelib by using importlib.resources (available since python 3.7)

• git grep 'SAGE_EXTCODE' src/sage
• git grep '__file__' src/sage

This will help make sagelib zip_safe (https://setuptools.readthedocs.io/en/latest/userguide/miscellaneous.html#setting-the-zip-safe-flag)

In this ticket, we take care of sage.repl, moving data needed by its doctests from SAGE_EXTCODE (= src/sage/ext_data) into the package directory. (Thus, we avoid a dependency on support for resources in namespace packages brought by Python 3.10(?) or the backport package importlib-resources, see python/importlib_resources#196)

Follow-up tickets will deal with other parts of the library. In the end, the directory src/sage/ext_data will be eliminated.

References:

• https://docs.python.org/3/library/importlib.html#module-importlib.resources
• https://importlib-resources.readthedocs.io/en/latest/migration.html
• https://importlib-resources.readthedocs.io/en/latest/using.html

CC: @tobiasdiez @fchapoton @kiwifb @dimpase @soehms @tscrim

Component: refactoring

Author: Matthias Koeppe

Branch/Commit: d925cd2

Reviewer: Dima Pasechnik

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

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,10 +1,8 @@
-We eliminate direct reading of files from the package directories of sagelib by using `importlib.resources`. 
+We eliminate direct reading of files from the package directories of sagelib by using `importlib.resources` (available since python 3.7) 
 - `git grep 'SAGE_EXTCODE' src/sage`
 - `git grep '__file__' src/sage`
 
 This will help make sagelib `zip_safe` (https://setuptools.readthedocs.io/en/latest/userguide/miscellaneous.html#setting-the-zip-safe-flag)
-
-(requires python 3.7 (hence the dependency on #30551) or add the backport package `importlib_resources` if we want to support 3.6 - but that does not support resources within native namespace packages)
 
 References:
 - https://docs.python.org/3/library/importlib.html#module-importlib.resources

[mkoeppe]

Changed dependencies from #30551 to #30551, #31386

[mkoeppe]

Branch: u/mkoeppe/replace_use_of_sage_extcode_by_importlib_resources

[mkoeppe]

Commit: b2cb173

[mkoeppe]

Last 10 new commits:

77c957f	src/doc/en/developer/packaging_sage_library.rst: Put hierarchy section one level higher
9375ef8	pkgs/sagemath-standard/tox.ini: Use SAGE_VENV or venv symlink to find wheels
c6fc111	Prettier diagram
7d6a44c	Use :mod: as markup for packages/modules
f83d424	Improve ABC example
817a8d0	src/doc/en/developer/packaging_sage_library.rst: More :mod: and :class: markup
b555735	src/doc/en/developer/packaging_sage_library.rst: Link to pypi.org and to documentation of packaging metadata
81e9c9a	Merge #32899
af47b5f	Merge #31386
b2cb173	src/sage/repl/rich_output/: Move example files here from src/sage/ext_data, use importlib.resources

[sagetrac-git]

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

0f63cce

src/sage/repl/display/formatter.py: Replace use of SAGE_EXTCODE in doctest by importlib.resources

[sagetrac-git]

Changed commit from b2cb173 to 0f63cce

[mkoeppe]

Author: Matthias Koeppe

[mkoeppe]

Changed dependencies from #30551, #31386 to #31386

[mkoeppe]

Description changed:

--- 
+++ 
@@ -3,6 +3,8 @@
 - `git grep '__file__' src/sage`
 
 This will help make sagelib `zip_safe` (https://setuptools.readthedocs.io/en/latest/userguide/miscellaneous.html#setting-the-zip-safe-flag)
+
+In this ticket, we take care of `sage.repl`. Follow-up tickets will deal with other parts of the library.
 
 References:
 - https://docs.python.org/3/library/importlib.html#module-importlib.resources

[sagetrac-git]

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

09787af

Merge tag '9.5.beta8' into t/31306/replace_use_of_sage_extcode_by_importlib_resources

[sagetrac-git]

Changed commit from 0f63cce to 09787af

[mkoeppe]

Description changed:

--- 
+++ 
@@ -10,6 +10,6 @@
 - https://docs.python.org/3/library/importlib.html#module-importlib.resources
 - https://importlib-resources.readthedocs.io/en/latest/migration.html
 - https://importlib-resources.readthedocs.io/en/latest/using.html
+- https://github.com/python/importlib_resources/pull/196 - Add support for resources in namespace packages
 
 
-

[mkoeppe]

Description changed:

--- 
+++ 
@@ -4,12 +4,13 @@
 
 This will help make sagelib `zip_safe` (https://setuptools.readthedocs.io/en/latest/userguide/miscellaneous.html#setting-the-zip-safe-flag)
 
-In this ticket, we take care of `sage.repl`. Follow-up tickets will deal with other parts of the library.
+In this ticket, we take care of `sage.repl`, moving data needed by its doctests from `SAGE_EXTCODE` (= `src/sage/ext_data`) into the package directory. (Thus, we avoid a dependency on support for resources in namespace packages brought by Python 3.10(?) or the backport package `importlib-resources`, see https://github.com/python/importlib_resources/pull/196)
+
+Follow-up tickets will deal with other parts of the library. In the end, the directory `src/sage/ext_data` will be eliminated.
 
 References:
 - https://docs.python.org/3/library/importlib.html#module-importlib.resources
 - https://importlib-resources.readthedocs.io/en/latest/migration.html
 - https://importlib-resources.readthedocs.io/en/latest/using.html
-- https://github.com/python/importlib_resources/pull/196 - Add support for resources in namespace packages
 
 

[mkoeppe]

comment:13

The testsuite failures are unrelated