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

[pyreverse] Dunder methods in diagrams #9805

Open
kidq330 opened this issue Jul 16, 2024 · 1 comment · May be fixed by #9806
Open

[pyreverse] Dunder methods in diagrams #9805

kidq330 opened this issue Jul 16, 2024 · 1 comment · May be fixed by #9806
Labels
Documentation 📗 Work in progress

Comments

@kidq330
Copy link

kidq330 commented Jul 16, 2024

Current problem

I'm using pyreverse to visualize the structure of sympy which is a fairly large project, with a lot of relations modelled by classes, but also some functionality like iterators implemented via dunder methods.

I understand the decision behind not including private methods, but some of the special dunder methods, I'd argue, are part of the public API of an object and so they should be included in the diagram, wdyt?

Desired solution

Special methods (__next__, __iter__, __str__ etc.)should show up in diagrams as member methods, just like public methods do now

Additional context

No response
@kidq330 kidq330 added the Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling label Jul 16, 2024
@kidq330 kidq330 changed the title Dunder methods in diagrams [pyreverse] Dunder methods in diagrams Jul 16, 2024
@kidq330
Copy link
Author

kidq330 commented Jul 16, 2024 •
edited
Loading

Whoops, might've created the issue too early, I see -f SPECIAL_A does exactly what I wanted, though it isn't explicitly mentioned by the help message. I'll keep the issue open and fix up a PR with modified docs

edit: the output differs when using -fSPECIAL and -fSPECIAL_A, but pyreverse prints Unknown filter mode 'SPECIAL_A' when using the latter.

@Pierre-Sassoulas Pierre-Sassoulas added Documentation 📗 Work in progress and removed Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling labels Jul 16, 2024
@kidq330 kidq330 linked a pull request Jul 16, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation 📗 Work in progress
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[pyreverse] updated docs for filter-mode kidq330/pylint
2 participants
@Pierre-Sassoulas @kidq330