Remove useless 'from . import all' from some init.py files

Question

Remove useless 'from . import all' from some init.py files

Closed this issue 4 years ago · 21 comments

... and similar imports of modules in the package, found via

find src/sage -name '__init__.py' | xargs grep import

Possibly some of them are needed to break circular imports, but likely not all of them.

Part of #32501.

Depends on #32506

CC: @tscrim @fchapoton

Component: refactoring

Author: Matthias Koeppe

Branch/Commit: 55ca4bc

Reviewer: Frédéric Chapoton

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

Answer 1 · 2021-09-12T05:50:23.000Z

Description changed:

--- 
+++ 
@@ -1,3 +1,5 @@
+... and similar imports of modules in the package.
+
 Possibly some of them are needed to break circular imports, but likely not all of them.
 
 Part of #32501.

Answer 2 · 2021-09-12T05:54:49.000Z

Branch: u/mkoeppe/remove_useless__from___import_all__from_some___init___py_files

Answer 3 · 2021-09-12T05:59:52.000Z

Commit: 8efece0

Answer 4 · 2021-09-12T05:59:52.000Z

comment:3

In src/sage/combinat/__init__.py, there is

from . import quickref
from . import tutorial

These are modules without code. Are these imports needed for anything?

New commits:

`8efece0`	`sage.graphs, sage.graphs.graph_decompositions: Remove unnecessary import of modules`

Answer 5 · 2021-09-13T06:01:19.000Z

comment:4

from . import all was previously discussed in #20617 comment:16

Answer 6 · 2021-09-13T06:13:16.000Z

Author: Matthias Koeppe

Answer 7 · 2021-09-13T06:21:36.000Z

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

`892f2e7`	`Remove all 'from . import all' from __init__.py files`

Answer 8 · 2021-09-13T06:21:36.000Z

Changed commit from 8efece0 to 892f2e7

Answer 9 · 2021-09-13T06:25:16.000Z

Description changed:

--- 
+++ 
@@ -1,4 +1,8 @@
-... and similar imports of modules in the package.
+... and similar imports of modules in the package, found via
+
+```
+find src/sage -name '__init__.py' | xargs grep import
+```
 
 Possibly some of them are needed to break circular imports, but likely not all of them.

Answer 10 · 2021-09-13T06:34:32.000Z

comment:8

Replying to @mkoeppe:

In src/sage/combinat/__init__.py, there is
from . import quickref
from . import tutorial
These are modules without code. Are these imports needed for anything?

Also:

src/sage/categories/__init__.py:from . import primer

Answer 11 · 2021-09-13T06:43:46.000Z

comment:9

I am guessing these are some kind of workarounds for the sphinx docbuild?
We can take care of them in #32508.

Answer 12 · 2021-09-13T09:27:20.000Z

comment:10

looks good, but does it pass the doctests with optional - dot2tex ?

Answer 13 · 2021-09-13T15:15:12.000Z

comment:11

Just tested, yes it does

Answer 14 · 2021-09-13T16:13:24.000Z

comment:12

ok, thx. Then let's go

Answer 15 · 2021-09-13T16:13:24.000Z

Reviewer: Frédéric Chapoton

Answer 16 · 2021-09-13T17:34:10.000Z

comment:13

Thank you!

Answer 17 · 2021-09-13T17:36:44.000Z

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. New commits:

`1c106cd`	`Remove useless 'file is not empty' comments from __init__.py files`
`55ca4bc`	`Merge branch 't/32506/remove_useless__file_is_not_empty__comments_from___init___py_files' into t/32507/remove_useless__from___import_all__from_some___init___py_files`

Answer 18 · 2021-09-13T17:36:44.000Z

Changed commit from 892f2e7 to 55ca4bc

Answer 19 · 2021-09-13T17:37:15.000Z

comment:15

Merged #32506 to remove the trivial merge conflicts

Answer 20 · 2021-09-13T17:37:15.000Z

Dependencies: #32506

Answer 21 · 2021-09-19T09:58:01.000Z

Changed branch from u/mkoeppe/remove_useless__from___import_all__from_some___init___py_files to 55ca4bc