Commit hacky script to visualise store inheritance

[DMRobertson]

Use e.g. with scripts-dev/storage_inheritance.py DataStore --show.

It's dirty, but it's useful enough to help disentangle the sphagetti.

[DMRobertson]

scripts-dev/storage_inheritance.py DataStore --show running at 9e361c8:

scripts-dev/storage_inheritance.py BaseSlavedStore --show at cd7257bf27b0344266ae507085066c9c6c604b6d:

scripts-dev/storage_inheritance.py --show at 9e361c8:

[babolivier]

We should add networkx to the dev dependencies.

[babolivier]

I assume we probably want to change this so it doesn't point to your home directory.

[babolivier]

Also I would suggest writing the file on disk rather than opening it. For example I know Gnome has some weird magic around default apps, and when I tried running the script it opened it with Gimp for some reason despite the fact that I've changed the default app for PNGs to something else some time ago.

[DMRobertson]

Also I would suggest writing the file on disk rather than opening it.

There's a command line option for this: --output DEST.

For example I know Gnome has some weird magic around default apps, and when I tried running the script it opened it with Gimp for some reason despite the fact that I've changed the default app for PNGs to something else some time ago.

Suggest checking your config with:

$ xdg-mime query default image/png
org.gnome.eog.desktop

[babolivier]

There's a command line option for this: --output DEST.

Hah, I see. Maybe worth adding some doc along with the script so we remember how to use it, then? Otherwise I'm afraid it'll become like the config validator/parser util in Synapse and we'll completely forget it's a thing until someone complains we don't have such a tool or it's broken.

[DMRobertson]

Hah, I see. Maybe worth adding some doc along with the script so we remember how to use it, then?

I use argparse so there's a --help out of the box for this

[anoadragon453]

What's the expected lifetime of this script? Do we expect to remove it once DataStore is less 🍝?

[clokep]

I'm going to remove this from the review queue since it seems to be awaiting info from @DMRobertson.

[DMRobertson]

What's the expected lifetime of this script? Do we expect to remove it once DataStore is less spaghetti?

I hadn't really considered it, but that sounds sensible.

(I can imagine a version that imports a class and inspects __mro__ attributes to build this graph, but hopefully we aren't relying on inheritance to this extent anywhere else?)

[DMRobertson]

I'm going to close this for now since I don't think we're getting to this any time soon.

If we want to tackle our monstrous store classes we can resurrect this if it's useful.

Cross-refs: #11733, #11165