Refactoring tool to fix modularization anti-patterns #34945

mkoeppe · 2023-01-28T22:17:01Z

The new command sage --fiximports replaces imports from sage.PAC.KAGE.all by more specific imports when sage.PAC.KAGE is an implicit namespace package.

Part of Meta-ticket #34201

Depends on #34849

CC: @alexchandler100

Component: scripts

Author: Alex Chandler, Matthias Koeppe

Branch/Commit: u/mkoeppe/replace_dot_all @ e74dbf6

Reviewer: Matthias Koeppe, Alex Chandler

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

The text was updated successfully, but these errors were encountered:

mkoeppe · 2023-01-28T22:17:38Z

Branch: u/mkoeppe/replace_dot_all

sagetrac-git · 2023-01-28T23:03:48Z

Commit: 294e3e9

sagetrac-git · 2023-01-28T23:03:48Z

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

`7a54612`	`New command 'sage --fiximports', invokes sage.misc.replace_dot_all`
`294e3e9`	`src/sage/misc/replace_dot_all.py: Break some long lines`

sagetrac-git · 2023-01-28T23:48:54Z

Changed commit from 294e3e9 to b8b4372

sagetrac-git · 2023-01-28T23:48:54Z

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

`057dfb5`	`src/sage/misc/replace_dot_all.py: Pass package_regex, not regex including 'import '`
`b8b4372`	`src/sage/misc/replace_dot_all.py (make_replacements_in_file): Add optional arg 'output'`

sagetrac-git · 2023-01-29T00:38:27Z

Changed commit from b8b4372 to 01efec0

sagetrac-git · 2023-01-29T00:38:27Z

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

`46a15bf`	`src/sage/misc/replace_dot_all.py: Pass package_regex, not regex including 'import ' (fixup)`
`2cbbf2d`	`src/sage/misc/replace_dot_all.py: Use more 'with open'`
`29e5ddb`	`src/sage/misc/replace_dot_all.py: Replace sort_log_messages by print_log_messages`
`01efec0`	`src/sage/misc/replace_dot_all.py: Use endswith()`

sagetrac-git · 2023-01-29T01:00:22Z

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

`810d982`	`src/sage/misc/replace_dot_all.py: Replace -l with positional argument, handle multiple files/dirs, do not use directory prefix`

sagetrac-git · 2023-01-29T01:00:22Z

Changed commit from 01efec0 to 810d982

sagetrac-git · 2023-01-29T01:04:48Z

Changed commit from 810d982 to dbcccc1

sagetrac-git · 2023-01-29T01:04:48Z

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

`dbcccc1`	`src/sage/misc/replace_dot_all.py: Replace -l with positional argument, handle multiple files/dirs, do not use directory prefix`

sagetrac-git · 2023-01-29T01:05:40Z

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

`491805d`	`src/sage/misc/replace_dot_all.py: Replace -l with positional argument, handle multiple files/dirs, do not use directory prefix`

sagetrac-git · 2023-01-29T01:05:40Z

Changed commit from dbcccc1 to 491805d

sagetrac-git · 2023-01-29T02:14:41Z

Changed commit from 491805d to bf5e6d2

sagetrac-git · 2023-01-29T02:14:41Z

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

`8cef447`	`src/sage/misc/replace_dot_all.py: Restore print_log_messages lost in previous commit`
`aa5f1e4`	`src/sage/misc/replace_dot_all.py: Clean docstrings, uncamelcaps`
`202cdc5`	`src/sage/misc/replace_dot_all.py: Update doctests`
`bf5e6d2`	`src/sage/misc/replace_dot_all.py: Simplify some 'if' conditions`

sagetrac-git · 2023-01-29T02:29:05Z

Changed commit from bf5e6d2 to b426778

sagetrac-git · 2023-01-29T02:29:05Z

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

`b426778`	`src/sage/misc/replace_dot_all.py: Doc updates, pycodestyle fixes`

sagetrac-git · 2023-01-29T02:31:54Z

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

`685680b`	`src/sage/misc/replace_dot_all.py: Use isinstance instead of type(...) == ...`

sagetrac-git · 2023-01-29T02:31:54Z

Changed commit from b426778 to 685680b

sagetrac-git · 2023-01-29T02:33:39Z

Changed commit from 685680b to 0b8dd2f

sagetrac-git · 2023-01-29T02:33:39Z

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

`0b8dd2f`	`src/sage/misc/replace_dot_all.py: Fixup`

sagetrac-git · 2023-01-29T03:02:27Z

Changed commit from 0b8dd2f to 1c19d43

sagetrac-git · 2023-01-29T03:02:27Z

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

`d296b7c`	`src/sage/misc/replace_dot_all.py: Replace 'row number', 'line number' by :`
`ac83a49`	`src/sage/misc/replace_dot_all.py: Use __import__`
`fe617e9`	`src/sage/misc/replace_dot_all.py: Fold parse_arguments into main`
`1c19d43`	`src/sage/misc/replace_dot_all.py: Fix doctests`

mkoeppe · 2023-01-29T03:03:01Z

Reviewer: Matthias Koeppe, ...

mkoeppe · 2023-01-29T03:03:01Z

Changed author from Alex Chandler to Alex Chandler, Matthias Koeppe

sagetrac-git · 2023-01-29T03:11:48Z

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

`23dff24`	`src/sage/misc/replace_dot_all.py: Simplify print_log_messages, fold into main`

sagetrac-git · 2023-01-29T03:11:48Z

Changed commit from 1c19d43 to 23dff24

sagetrac-git · 2023-01-29T03:14:29Z

Changed commit from 23dff24 to 568c538

sagetrac-git · 2023-01-29T03:14:29Z

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

`568c538`	`src/sage/misc/replace_dot_all.py: Use os.path.join more`

sagetrac-git · 2023-01-29T03:21:22Z

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

`eef9cd5`	`src/doc/en/developer/packaging_sage_library.rst: Mention relint, sage --fiximports`

sagetrac-git · 2023-01-29T03:21:22Z

Changed commit from 568c538 to eef9cd5

mkoeppe · 2023-01-29T03:25:51Z

comment:17

Alex, your code works well. I have only made minor changes that bring the command line interface in line with similar tools, and some style changes.

It has proper doctest coverage now and passes the code style tests.

If you have a chance to look through my changes, you can add your name to "Reviewers"

sagetrac-git · 2023-01-29T03:29:40Z

Changed commit from eef9cd5 to e74dbf6

sagetrac-git · 2023-01-29T03:29:40Z

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

`e74dbf6`	`src/sage/misc/replace_dot_all.py: Add copyright notice`

mkoeppe · 2023-01-29T07:12:54Z

Dependencies: #34849

mkoeppe · 2023-01-29T07:12:54Z

comment:20

The Lint and Build&Test failures are unrelated to the changes here.

alexchandler100 · 2023-01-29T17:45:09Z

comment:21

I've taken a look, and the changes all look great to me. I've added my name to the reviewers.

alexchandler100 · 2023-01-29T17:45:09Z

Changed reviewer from Matthias Koeppe, ... to Matthias Koeppe, Alex Chandler

The new command `sage --fiximports` replaces imports from `sage.PAC.KAGE.all` by more specific imports when `sage.PAC.KAGE` is an implicit namespace package. Part of Meta-ticket #34201 URL: https://trac.sagemath.org/34945 Reported by: mkoeppe Ticket author(s): Alex Chandler, Matthias Koeppe Reviewer(s): Matthias Koeppe, Alex Chandler

….*.all for namespace packages Using `./sage -fiximports` from #34945. Also remove trailing whitespace in the affected files. Part of Meta-ticket #32414 URL: https://trac.sagemath.org/34947 Reported by: mkoeppe Ticket author(s): Alex Chandler Reviewer(s): Travis Scrimshaw, Matthias Koeppe

…ce packages Using `./sage -fiximports` from #34945. Also remove trailing whitespace in the affected files. Part of Meta-ticket #32414 URL: https://trac.sagemath.org/34952 Reported by: mkoeppe Ticket author(s): Alex Chandler Reviewer(s): David Coudert

…l for namespace packages Using `./sage -fiximports` from #34945. Also remove trailing whitespace in the affected files. Part of Meta-ticket #32414 URL: https://trac.sagemath.org/34956 Reported by: mkoeppe Ticket author(s): Alex Chandler, Matthias Koeppe Reviewer(s): Travis Scrimshaw

mkoeppe · 2023-02-13T00:59:56Z

Merged in 10.0.beta0

mkoeppe added this to the sage-9.8 milestone Jan 28, 2023

mkoeppe added c: scripts labels Jan 28, 2023

mkoeppe added the s: needs review label Jan 29, 2023

This comment has been minimized.

Sign in to view

mkoeppe added s: positive review and removed s: needs review labels Jan 29, 2023

mkoeppe modified the milestones: sage-9.8, sage-9.9 Jan 29, 2023

mkoeppe closed this as completed Feb 13, 2023

mkoeppe removed the s: positive review label Feb 13, 2023

Refactoring tool to fix modularization anti-patterns #34945

Refactoring tool to fix modularization anti-patterns #34945

Comments

mkoeppe commented Jan 28, 2023

mkoeppe commented Jan 28, 2023

sagetrac-git mannequin commented Jan 28, 2023

sagetrac-git mannequin commented Jan 28, 2023

sagetrac-git mannequin commented Jan 28, 2023

sagetrac-git mannequin commented Jan 28, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

mkoeppe commented Jan 29, 2023

mkoeppe commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

mkoeppe commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

sagetrac-git mannequin commented Jan 29, 2023

This comment has been minimized.

mkoeppe commented Jan 29, 2023

mkoeppe commented Jan 29, 2023

alexchandler100 commented Jan 29, 2023

alexchandler100 commented Jan 29, 2023

mkoeppe commented Feb 13, 2023