LoggingBackend - delegating MIP backend class that logs input/output to backend methods

[mkoeppe]

This is a debugging tool. It logs calls to the methods of MIP backends.

There are three output formats:

• on-screen comments
• doctests, suitable for cut and paste
• _test_* methods for the backends (#20323).

I have already used this code to translate the testcase using the MixedIntegerLinearProgram reported in #18572 to a testcase in the style of the _test_* methods for the backends. The result has been committed on #20424 .

[git]

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

​756015f	LoggingBackend: add test method writer
​a9535a7	Use assertAlmostEqual for float; don't log zero and base_ring
​e7ef1ea	Add doctest

[mkoeppe]

The branch is on top of #20406. The _test methods that this class generates mimic the ones written in #20323, which is why I mark it as a dependency.

[git]

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

​d1d84c6	get_solver: Add doctest
​cc2d999	Mention solver=callable in docstrings and error messages
​37e87a5	Replace delsarte test by one that does not expose a bug in GLPK exact
​2b0626f	First attempt at LoggingBackend
​4e5c439	This is as far as we get with __getattr__
​5282a79	LoggingBackend: Inherit from GenericBackend, override methods
​deedc16	LoggingBackend: add test method writer
​cc845f7	Use assertAlmostEqual for float; don't log zero and base_ring
​2f4b58c	Add doctest
​4983cc7	Fix docstring

[mkoeppe]

rebased on top of current #20406.

[dimpase]

it would be great to have a concrete explained example in the docs like "suppose we want to test that foo does baz. Then we..."

[git]

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

​632e81d	First attempt at LoggingBackend
​3c96d9f	This is as far as we get with __getattr__
​123c066	LoggingBackend: Inherit from GenericBackend, override methods
​8c2612d	LoggingBackend: add test method writer
​9c69834	Use assertAlmostEqual for float; don't log zero and base_ring
​422226c	Add doctest
​b66cd6d	Fix docstring
​1226179	Add more documentation and examples

[mkoeppe]

I've added a better example.

[dimpase]

there is no trace of this backend in the docs. You probably want to add it to some index in an rst file...

[git]

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

​cea8e06	Add logging_backend to documentation index
​a221767	Use print_function and output get_solver calls too

[mkoeppe]

Thanks for the reminder; I've added it to the documentation index.

[dimpase]

in

call `compute_something` in the doctest

compute_something is being typeset in the doc as a maths expression. I guess it needs :func: prefix.

As well, after EXAMPLES there is a long list

add_col(*args, **kwdargs)
add_linear_constraint(*args, **kwdargs)
...
write_mps(*args, **kwdargs)

Is it how it is meant to look?

[git]

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

​b1db4dc

Improvement for generated documentation

[mkoeppe]

I've fixed the markup of that function, actually using double-backquotes.

The long list is a list of all instrumented methods that comes from the backend. I don't know if it should be suppressed, and if yes, how. I also don't know how to remove the strange stuff at the very bottom of that page.

[dimpase]

patchbots complain

Missing doctests in numerical/backends/logging_backend.py: 1 / 5 = 20%

[dimpase]

Replying to mkoeppe:

The long list is a list of all instrumented methods that comes from the backend. I don't know if it should be suppressed, and if yes, how.

You can place .. auto*** directives in the docstrings of classes; although I don't exactly know how to achieve what we want. See the doc here: ​http://www.sphinx-doc.org/en/stable/ext/autodoc.html#confval-autoclass_content

and there are examples in src/sage/ doing something like this: grep -R "\.\. auto" * will show a lot...

I also don't know how to remove the strange stuff at the very bottom of that page.

no idea either...

[git]

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

​d39dfde	LoggingBackend: Inherit from GenericBackend, override methods
​028c64f	LoggingBackend: add test method writer
​9df27fd	Use assertAlmostEqual for float; don't log zero and base_ring
​9408e50	Add doctest
​dd95cb9	Fix docstring
​0d2e9d9	Add more documentation and examples
​07bd122	Add logging_backend to documentation index
​b69f62d	Use print_function and output get_solver calls too
​9fbba6d	Improvement for generated documentation
​879c033	Add documentation to wrappers and clean up namespace. Fixes generated documentation

[mkoeppe]

Found a solution for the documentation.

[git]

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

​a549842

Add doctests

[git]

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

​05c6c38

Faking the base_ring

[git]

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

​f17cd9b

LoggingBackendFactory: Make the interface more user-friendly

[dimpase]

looks good to me. By the way, you use deprecated db() stuff. Are you going to undo #2536 ?

[mkoeppe]

I'm not using it. The LoggingBackend simply instruments every method that the backend has, including stuff that I never heard of or that was deprecated a decade ago.

[dimpase]

Ah, OK, never mind then (I had a quick look at generated docs, and saw that db() there...)