1992 corfunc perspective needs export and report capabilities

[lucas-wilkins]

This is an early pull request for part of my implementation of reports for corfunc (issue #1992).

As it stood, each perspective was treated differently, the main content of this pull request is a base class for all the perspectives that contains functionality that they should all support. This includes the getReport method.

As you will see, I have left many TODO notes in the new class, and in some of the perspectives too. The plan is to implement these at the end dealing with the current issue. These are mostly renaming, consistent use of getters/setters, removing some unused bits of code etc, it should be pretty easy now that they reference a common base class.

There is one TODO note that would be part of the task of disentangling GUI stuff from the rest of the code.

Additionally, I have converted a list of objects into a named (and typed) tuple called ReportData, and added some typing surrounding it.

[lucas-wilkins]

Final bits are now done - @smk78, @wpotrzebowski and whoever else is interested.

Most of my additions are now in a folder called reports.

I have now included a couple more packages, which I've added to requirements.txt, but nowhere else:

html2text -> for converting html to text, instead of using regex (html is not a regular language, regular expressions are not appropriate). This package is old, but it was written by Aaron Swartz - RIP, and the text produced is actually RST, so with the appropriate renderer the text output will show proper tables and even figures.

importlib-resources and importlib_resources -> standard package for correctly addressing non-python files within a python package. If we are sure we will be in python >3.7, then only the former is needed.

[rprospero]

Just a couple of minor optional stylist suggestions

[krzywon]

This cleans up perspectives quite a bit and does what it says it does by adding report capabilities to the corfunc perspective. I'd suggest looking at the one error I saw, otherwise, I have a number of suggestions, but those could always be TODOs.

[krzywon]

This is ready to be merged. The two outstanding suggestions I have should be documented in their own feature requests, assuming they aren't implemented here.

[rozyczko]

At least on windows, this also needs importlib_resources and html2text

[lucas-wilkins]

OK, yeah, that needs to be done. Will fix when I'm back at work.

[lucas-wilkins]

Fixed in latest push, if you're happy with it, merge it, I think its time.

[rozyczko]

thanks, go ahead

[rozyczko]

Currently, the two reports: from Fitting and from Corfunc look rather different, having non-matching font, layout, section names etc.
Should we strive to be at least a bit more consistent?

[lucas-wilkins]

Yeah, there's an open issue for that. Unify report blah blah something, I'm away so can't give you the number right now.

…

On Fri, 8 Jul 2022, 09:47 Piotr Rozyczko, ***@***.***> wrote: Currently, the two reports: from Fitting and from Corfunc look rather different, having non-matching font, layout, section names etc. Should we strive to be at least a bit more consistent? [image: repors] <https://user-images.githubusercontent.com/8266281/177954489-4346a646-2017-4b6f-b6db-69b5269a7ab5.png> — Reply to this email directly, view it on GitHub <#2065 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACKU4SX46AUFP3FZFH5NX6DVS7TINANCNFSM5YJ5ZIBQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[lucas-wilkins]

#2075

Currently, the two reports: from Fitting and from Corfunc look rather different, having non-matching font, layout, section names etc. Should we strive to be at least a bit more consistent?

#2075