Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[GSOC] feat: auto-importing django shell #18158

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

[GSOC] feat: auto-importing django shell #18158

wants to merge 7 commits into from
+165 −5

Conversation

salvo-polizzi
Copy link
Contributor

@salvo-polizzi salvo-polizzi commented May 11, 2024 •
edited

Branch description

This would be an update of the existing Django shell that auto-imports models for you from your app/project. Also, the goal would be to allow the user to subclass this shell to customize its behavior and import extra things.

TODO

  • Auto-import all models from the current project/app.
  • Test subclassing the shell command and override a method.
  • Test importing extra-things (modules, classes, etc.).
  • Write a tutorial and document the new features.

Checklist

  • This PR targets the main branch.
  • The commit message is written in past tense, mentions the ticket number, and ends with a period.
  • I have added or updated relevant tests.
  • I have added or updated relevant docs, including release notes if applicable.
  • I have attached screenshots in both light and dark modes for any UI changes.

@salvo-polizzi salvo-polizzi marked this pull request as draft May 12, 2024 15:12
@adamchainz adamchainz mentioned this pull request May 14, 2024
Closed
adamchainz
adamchainz suggested changes May 14, 2024
View reviewed changes
Copy link
Sponsor Member

@adamchainz adamchainz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following up from my post on the forum :) You got this !

django/core/management/commands/shell.py Outdated Show resolved Hide resolved
django/core/management/commands/shell.py Outdated Show resolved Hide resolved
django/core/management/commands/shell.py Outdated Show resolved Hide resolved
django/core/management/commands/shell.py Outdated Show resolved Hide resolved
@salvo-polizzi
Copy link
Contributor Author

Thank you so much, @adamchainz, for the feedback. Currently, I'm concentrating on writing tests for these features. Do you have any references or suggestions on where to start? I'm considering creating new functions within the shellCommandTestCase to test the auto-imports.

@adamchainz
Copy link
Sponsor Member

Yes, the tests should be within ShellCommandTestCase.

You can unit-test get_namespace() by calling it (imports = Command().get_namespace()) and making assertions on its contents. Then you can write integration tests similar to the existing ones that use command and captured_stdin to test those pathways.

It seems the existing tests don't actually cover launching the various shells. I think it’s worth trying adding coverage, at least for the default python shell, though there’s a risk that calling the startup file, interactive hook, or readline are not a good idea during a test run.

Import all models from project.
6cef57a 
* Deleted useless import_string function.

* Gave precedence to earlier apps.

* Loaded default imports with command option.
adamchainz
adamchainz reviewed May 16, 2024
View reviewed changes
Copy link
Sponsor Member

@adamchainz adamchainz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work getting some tests written! 💪

django/core/management/commands/shell.py Outdated Show resolved Hide resolved
tests/shell/models.py Outdated Show resolved Hide resolved
django/core/management/commands/shell.py Outdated Show resolved Hide resolved
django/core/management/commands/shell.py Outdated Show resolved Hide resolved
django/core/management/commands/shell.py Outdated Show resolved Hide resolved
Made changes requested by @adamchainz
c2a6351 
Fixed CI.

Ensured that command and stdin option had default imports.

Removed useless get_apps_and_models method.
adamchainz
adamchainz suggested changes May 20, 2024
View reviewed changes
Copy link
Sponsor Member

@adamchainz adamchainz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your continued iteration. I hope you learn some things from my comments here.

django/core/management/commands/shell.py Outdated Show resolved Hide resolved
django/core/management/commands/shell.py Outdated Show resolved Hide resolved
django/core/management/commands/shell.py Show resolved Hide resolved
django/core/management/commands/shell.py Outdated Show resolved Hide resolved
tests/shell/tests.py Show resolved Hide resolved
tests/shell/tests.py Outdated Show resolved Hide resolved
tests/shell/tests.py Outdated Show resolved Hide resolved
tests/shell/tests.py Outdated Show resolved Hide resolved
@salvo-polizzi
Copy link
Contributor Author

Thanks @adamchainz again for your reviews. I left some questions in the comments

Made changes requested by @adamchainz
a1582f0 
Deleted useless update_globals method.

Deleted useless test.

Minor improvements.

Setted maxDiff to None.

Updated installed apps for tests.
DevilsAutumn
DevilsAutumn reviewed May 22, 2024
View reviewed changes
tests/shell/tests.py Outdated Show resolved Hide resolved
DevilsAutumn
DevilsAutumn reviewed May 22, 2024
View reviewed changes
Copy link
Contributor

@DevilsAutumn DevilsAutumn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @salvo-polizzi , Thankyou for your constants efforts on this! And special thanks to Adam for reviewing. This PR looks in a great shape already. 🥇
I finally have some time to push this further.

@salvo-polizzi salvo-polizzi force-pushed the auto-importing-shell branch 2 times, most recently from 30f5b5d to 07c514f Compare May 23, 2024 08:50
Tested apps precedence using reversed.
10a17aa 
Fixed CI.

Fixed CI (II).

Fixed CI (III).
@salvo-polizzi salvo-polizzi marked this pull request as ready for review May 31, 2024 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DevilsAutumn DevilsAutumn DevilsAutumn left review comments

@adamchainz adamchainz Awaiting requested review from adamchainz

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@salvo-polizzi @adamchainz @DevilsAutumn