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 (Common TestSuite for MIP 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 .

Depends on #20406
Depends on #20323

CC: @dimpase @videlec @vbraun @nthiery

Component: numerical

Author: Matthias Koeppe

Branch/Commit: f17cd9b

Reviewer: Dima Pasechnik

Issue created by migration from https://trac.sagemath.org/ticket/20376

[mkoeppe]

Branch: u/mkoeppe/loggingbackend___delegating_mip_backend_class_that_logs_input_output_to_backend_methods

[sagetrac-git]

Commit: e7ef1ea

[sagetrac-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]

Description changed:

--- 
+++ 
@@ -1,5 +1,10 @@
-This is a debugging tool. The delegating class looks much like `HybridBackend` from #18735.
+This is a debugging tool. It logs calls to the methods of MIP backends.
 
-The logging should be done (optionally) in a way that testcases using `MixedIntegerLinearProgram` such as the the one reported in #18572 are translated to testcases for backends, suitable for copy-pasting into new `_test` methods (#20323).
+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 #20323.
 
 

[mkoeppe]

comment:3

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.

[mkoeppe]

Dependencies: #20406, #20323

[sagetrac-git]

Changed commit from e7ef1ea to 4983cc7

[sagetrac-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]

comment:5

rebased on top of current #20406.

[mkoeppe]

Description changed:

--- 
+++ 
@@ -5,6 +5,6 @@
 - 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 #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 .
 
 

[mkoeppe]

Author: Matthias Koeppe

[dimpase]

comment:7

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..."

[sagetrac-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

[sagetrac-git]

Changed commit from 4983cc7 to 1226179

[mkoeppe]

comment:9

I've added a better example.