singular.version() has no doctest

[simon-king-jena]

Neither singular.version nor singular_version have doc tests.

Upstream: Completely fixed; Fix reported upstream

CC: @kedlaya

Component: interfaces

Keywords: singular version help.cnf

Author: Jori Mäntysalo

Branch/Commit: 87c73ac

Reviewer: Jeroen Demeyer

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

[simon-king-jena]

comment:1

Remark:

Apparently the problem is on the side of Singular.

In Singular, freshly started, when you do

> system("--version");

there is the error (it says "? cannot open help.cnf"). If you repeat, no error.

If people think that my suggestion would break code, I suggest to have a new method singular.version_number().

[simon-king-jena]

comment:2

Replying to @simon-king-jena:

Apparently the problem is on the side of Singular.

And meanwhile it is reported upstream.

I do not know, however, if the problem still occurs with Singular 3-1-0 (I only have a beta version, and this still shows the error).

[simon-king-jena]

comment:3

Replying to @simon-king-jena:

Replying to @simon-king-jena: And meanwhile it is reported upstream.

I do not know, however, if the problem still occurs with Singular 3-1-0 (I only have a beta version, and this still shows the error).

"Upstream" answered, and it seems that the problem is fixed in the official release.

I could verify that on the server in Oberwolfach, the error does not occur in Singular 3-1-0, but it does occur in Oberwolfach in Singular 3-0-4 (as being part of Sage). Opinions?

But there still remains the question if singular.version() ought to return a tuple of integers, rather than a lengthy string with all build informations.

[aghitza]

comment:4

Replying to @simon-king-jena:

"Upstream" answered, and it seems that the problem is fixed in the official release.

I could verify that on the server in Oberwolfach, the error does not occur in Singular 3-1-0, but it does occur in Oberwolfach in Singular 3-0-4 (as being part of Sage). Opinions?

We can probably wait until after Sage Days 15 for this?

But there still remains the question if singular.version() ought to return a tuple of integers, rather than a lengthy string with all build informations.

My personal preference would be for it to return a tuple of integers, but we could give it an optional argument with_build_info=True (or verbatim=True or something similar) to make it return the lengthy string.

[simon-king-jena]

comment:5

Replying to @simon-king-jena:

I could verify that on the server in Oberwolfach, the error does not occur in Singular 3-1-0, but it does occur in Oberwolfach in Singular 3-0-4 (as being part of Sage). Opinions?

The "Opinions?" bit should be two lines lower. Sorry.

It turned out that the error occurs in any Sage-built Singular version that I know: Singular 3-0-4 on sage.math, on two of my computers, in Oberwolfach, and Singular 3-1-0-Beta on sage.math and on one of my computers.

If Singular is not built by Sage, then the error apparently does not occur: With Singular 3-0-3 (very old) on one of my machines, Singular-3-1-0-Beta on my machine (same sources, modulo the usual patches, as the sage-built version!), and Singular-3-1-0 official release in Oberwolfach.

So, after all, it seems to me that it is all Sage's fault.

But there still remains the question if singular.version() ought to return a tuple of integers, rather than a lengthy string with all build informations.

Here is where I want to know some "Opinions"...

[williamstein]

comment:6

The attached patch fixes the output format for version to be more consistent with the other interfaces, e.g., gp.version(). It also programs around the issue with help files, which is not fixed in Singular-3-1-0... and I'm not at all clear why it is considered a bug in Singular by the people in the thread above.

[simon-king-jena]

comment:7

Attachment: trac_5994.patch.gz

Replying to @williamstein:

It also programs around the issue with help files, which is not fixed in Singular-3-1-0... and I'm not at all clear why it is considered a bug in Singular by the people in the thread above.

Note that I originally thought that the issue with help files is a problem of Singular, and clearly a bug: I mean, you ask for the version number and get an error; you ask again, and it works! It had reported it upstream.

But then the impression came across (see my last post) that it only occurs in Singular if it is built by Sage. In this case, it could be a problem with the patched version in Sage, which might be worth another ticket.

Cheers, Simon

[williamstein]

comment:8

I think the first time you ask for the version, singular fires up its help system, and reports a bug about it not being properly configured by us for such use. Then it doesn't report that again, since it already did. I think it is very sensible behavior by Singular.

So can you review this?

[34f15714-f0fb-4cdc-a12b-f9764ca5444d]

comment:9

For the record, adding an empty $SAGE_ROOT/local/share/singular/help.cnf suppresses the error. There is actually a help.cnf file in the singular sources (, but it doesn't seem to get installed. Its contents don't look to be particularly relevant for sage at first glance, though.

[simon-king-jena]

comment:10

Replying to @williamstein:

So can you review this?

I'd like to, but the sage-4.3.1.alpha1 that I had built on sage-math seems broken. It used to work, but when I did ./sage -br main, it failed with

ImportError: /usr/lib/libstdc++.so.6: version `GLIBCXX_3.4.11' not found (required by /home/SimonKing/SAGE/sage-4.3.1.alpha1/local/lib/libgmpxx.so.3)

Might ./sage -ba work?

Anyway, I'd like to see one more doc test, that checks consistency with another way of getting the version number -- just for consistency:

sage: tuple([Integer(c) for c in singular.eval('system("version")')][:3] == singular.version()[0]
True

[simon-king-jena]

comment:11

Replying to @simon-king-jena:

...

sage: tuple([Integer(c) for c in singular.eval('system("version")')][:3] == singular.version()[0]
True

Oops, apparently I forgot a closing bracket on the left hand side. Anyway, you know what this prospective doc-test is supposed to do...

[simon-king-jena]

comment:12

Replying to @simon-king-jena:

Might ./sage -ba work?

It did not work. I fear that I have to start from scratch, so that it will take some hours before I will be able to review the patch.

[simon-king-jena]

comment:13

OK, meanwhile I built sage-4.3.1.rc1

The patch applies cleanly.

However, I don't like the doc tests, and I think the return value is wrong.

The tests check that the first version number is 3. OK, it will eventually change, but not in the near future.

Then they test that the version number is of length 3. Can we rely on it? There used to be two-digit versions.

In fact, the "official" version number seems to be four digits, not three:

sage: singular.eval('system("version")')
'3104'

Hence, the first return value of singular.version() should be (3,1,0,4) not (3,1,0). Note that according to the Singular homepage there is a version 3-1-0-6 available, so, the last digit does play a role.

So, my questions are:

• How important is it to have doc tests that remain valid if the Singular version changes?
• Do we take the patch level version number of Singular serious?

[simon-king-jena]

comment:14

Replying to @simon-king-jena:

So, my questions are:

• How important is it to have doc tests that remain valid if the Singular version changes?
• Do we take the patch level version number of Singular serious?

Is there an answer, yet?

[simon-king-jena]

comment:15

-- bump --

First question: Do we want that singular.version() works? Currently, it fails when first called.

Second question: Do we want that (at least by default) it returns a tuple of three or four numbers (three- resp four-digit vesion numbers), or do people like that the output of singular.version() (if it is called again after the initial error) returns a lengthy string with full information on the way Singular has been built?

[83660e46-0051-498b-a8c1-f7a7bd232b5a]

comment:16

It shouldn't hurt to install the help.cnf file though, in which case we wouldn't need (and should remove) the try ... except RuntimeError ... and a second try.

[83660e46-0051-498b-a8c1-f7a7bd232b5a]

Changed keywords from singular version to singular version help.cnf

[83660e46-0051-498b-a8c1-f7a7bd232b5a]

Author: William Stein

[83660e46-0051-498b-a8c1-f7a7bd232b5a]

comment:17

Since he reported this again on a duplicate, #11519.

[f29946bc-ee7b-48cd-9abc-3445948c551d]

comment:22

Replying to @simon-king-jena:

Do we want that (at least by default) it returns a tuple of three or four numbers (three- resp four-digit vesion numbers), or do people like that the output of singular.version() (if it is called again after the initial error) returns a lengthy string with full information on the way Singular has been built?

As a default I would suggest output similar to pari.version(). But for now at least kash_version() and r_version() gives slightly different output...

Maybe right way could be to remove them, and have something like version('kash') for one package and version() for all packages?

[simon-king-jena]

comment:23

Gosh, is that still not fixed? Sorry that I spoiled it by asking questions in comment:13 that nobody bothers to answer...

[simon-king-jena]

comment:24

To repeat my questions:

• How important is it to have doc tests that remain valid if the Singular version changes?

My answer: We could at least have a test marked random. In that way, we at least make sure that there is no error raised.

• Do we take the patch level version number of Singular serious? Respectively do we really want the current behaviour (singular.version() returns a lengthy string), or would we prefer to have it return a tuple of integers?

My answer: We have

sage: pari.version()
[2, 8, 0]
sage: r.version()
((3, 2, 1), 'R version 3.2.1 (2015-06-18)')
sage: gap.version()
'4.7.8'
sage: sage0.version()
'SageMath Version 6.9.beta3, Release Date: 2015-08-21'

Hence, the different interfaces have all kind of different output. Thus, the current behaviour should be fine, but the following output

sage: singular.eval('system("version")')
'3170'

would be equally fine.

My suggestion is: Use the SHORT version string by default, but provide singular_version and singular.version with an optional "verbose=False" argument, that allows to obtain the lengthy version string. And of course fix the error.

[f29946bc-ee7b-48cd-9abc-3445948c551d]

comment:25

Replying to @simon-king-jena:

To repeat my questions:

• How important is it to have doc tests that remain valid if the Singular version changes?

My answer: We could at least have a test marked random. In that way, we at least make sure that there is no error raised.

+1

My suggestion is: Use the SHORT version string by default, but provide singular_version and singular.version with an optional "verbose=False" argument, that allows to obtain the lengthy version string. And of course fix the error.

Sounds good. Somehow the output of pari.version() seems best for me. Maybe this could also be documented in http://doc.sagemath.org/html/en/developer/packaging.html#package-versioning as the recommended way to have *.version() commands?

[simon-king-jena]

comment:26

Replying to @jm58660:

Sounds good. Somehow the output of pari.version() seems best for me.

Slight problem: The patching level usually is not indicated by a number but by "p" plus a number. So, providing the version as a list of integers is perhaps not what we want. And it is not good, I think, if the default output is a list of integers and the verbose output is a totally different type, namely a string.

From that perspective, the r-output is better.

Maybe this could also be documented in http://doc.sagemath.org/html/en/developer/packaging.html#package-versioning as the recommended way to have *.version() commands?

I didn't know about the existence of a package_version.txt. I wonder if we could access these data---after all, the package version of singular is "3.1.7p1.p0", but the version shown by singular.eval('system("version")') is "3170". Similarly for r, it should be 3.2.1.p0, not (3,2,1).

I guess it is time to do a bit bike shedding at sage-devel.

[f29946bc-ee7b-48cd-9abc-3445948c551d]

comment:27

Replying to @simon-king-jena:

Slight problem: The patching level usually is not indicated by a number but by "p" plus a number. So, providing the version as a list of integers is perhaps not what we want. And it is not good, I think, if the default output is a list of integers and the verbose output is a totally different type, namely a string.

From that perspective, the r-output is better.

True.

As a system admin I should be able to answer fast to questions "What is the version of ... in our server ...?". For that it is not so important what is the format. But it gives a little unprofessional feeling if I get (1,2,3) from foo.version() and [1,2,3] from bar.version().

[simon-king-jena]

Branch: u/SimonKing/singular_version_yielding_error

[simon-king-jena]

Changed author from William Stein to William Stein, Simon King

[simon-king-jena]

comment:29

I work around the bug that results in the error, and I think it is best to return both a version tuple on the one hand (so that one can easily test if the version is enough recent) and the complete version information as provided by Singular as a string.

Hopefully the reviewers agree...

[simon-king-jena]

Commit: 70f7b1c

[simon-king-jena]

comment:30

Why is it not possible to click on the attached branch an see the changes?

[simon-king-jena]

comment:31

Arrgh. I forgot to commit before pushing :-/

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

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

a2ae8c8

Fix error in singular_version()

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 70f7b1c to a2ae8c8

[jdemeyer]

comment:33

The error should be reported upstream and the comment in the code should link to this ticket and the upstream report.

[simon-king-jena]

comment:34

I am not so sure if it requires an uptream report. The error is about a missing file, and according to comment:9, adding an empty $SAGE_ROOT/local/share/singular/help.cnf suppresses the error.

[jdemeyer]

comment:35

Replying to @simon-king-jena:

adding an empty $SAGE_ROOT/local/share/singular/help.cnf suppresses the error.

Then that should be done instead of wrapping the call in a try/except block (which is a really ugly "solution")

[jdemeyer]

comment:36

There is actually a help.cnf installed in

$SAGE_LOCAL/share/singular/LIB/help.cnf

so I guess it's a bug in Singular that the file is either installed or looked for in the wrong place.

In any case, copying that file to $SAGE_LOCAL/share/singular/help.cnf would be a good solution for this ticket.

[simon-king-jena]

comment:37

Replying to @jdemeyer:

There is actually a help.cnf installed in

$SAGE_LOCAL/share/singular/LIB/help.cnf

so I guess it's a bug in Singular that the file is either installed or looked for in the wrong place.

From reading this change log, I believe that .../share singular/LIB/ is the correct place.

I'll file a ticket in the singular trac server. But for now, we need a work-around in Sage.

[simon-king-jena]

comment:38

I reported it upstream.

[simon-king-jena]

Upstream: Reported upstream. No feedback yet.

[simon-king-jena]

comment:39

I stand corrected! There used to be $SAGE_LOCAL/share/singular/help.cnf, but it is gone. The only help.cnf found under $SAGE_ROOT is upstream/src/latest/Singular/LIB/help.cnf.

So, apparently we don't install it at all!

[jdemeyer]

comment:40

Replying to @simon-king-jena:

So, apparently we don't install it at all!

You're right, this must have come from some earlier Singular version (note the date):

$ ls -l local/share/singular/LIB/help.cnf
-rw-r--r-- 1 jdemeyer jdemeyer 3054 Oct 29  2014 local/share/singular/LIB/help.cnf

[jdemeyer]

comment:41

Replying to @simon-king-jena:

But for now, we need a work-around in Sage.

I suggest you just change spkg-install to touch the empty file $SAGE_SHARE/singular/help.cnf

[simon-king-jena]

comment:42

Replying to @jdemeyer:

Replying to @simon-king-jena:

But for now, we need a work-around in Sage.

I suggest you just change spkg-install to touch the empty file $SAGE_SHARE/singular/help.cnf

Why not modify spkg-install, so that it installs the missing file? Alternatively, we could patch Singular's Makefile (or whatever it is called) so that it installs the missing file. What is the preferred way?

Also, I'd like to know why Singular's Makefile does not install help.cnf. After all, if I understand correctly, it DOES install all the library files of Singular (which are in the same folder as help.cnf).

Hang on. I just notice that the singular spkg apparently screws completely. Or how would you explain that I find the complete UNPACKED singular source tree in SAGE_LOCAL/upstream/ ? Do we need a new Singular package?

[simon-king-jena]

comment:43

Upstream says that help.cnf should indeed be put into the same folder as all the other library files, i.e., local/share/singular/.

[simon-king-jena]

Changed upstream from Reported upstream. No feedback yet. to Reported upstream. Developers deny it's a bug.

[jdemeyer]

comment:44

Replying to @simon-king-jena:

Replying to @jdemeyer:

Replying to @simon-king-jena:

But for now, we need a work-around in Sage.

I suggest you just change spkg-install to touch the empty file $SAGE_SHARE/singular/help.cnf

Why not modify spkg-install, so that it installs the missing file? Alternatively, we could patch Singular's Makefile (or whatever it is called) so that it installs the missing file. What is the preferred way?

I don't really care much.

Hang on. I just notice that the singular spkg apparently screws completely. Or how would you explain that I find the complete UNPACKED singular source tree in SAGE_LOCAL/upstream/ ?

Probably you once extracted the tarball in upstream? It's not the package which does that...

[simon-king-jena]

comment:45

Replying to @jdemeyer:

Why not modify spkg-install, so that it installs the missing file? Alternatively, we could patch Singular's Makefile (or whatever it is called) so that it installs the missing file. What is the preferred way?

I don't really care much.

Then I guess we should do it in spkg-install.

Probably you once extracted the tarball in upstream? It's not the package which does that...

Could be. I just deleted it and did "sage -f singular".

[83660e46-0051-498b-a8c1-f7a7bd232b5a]

comment:46

There's also #sagemath on freenode. Just saying...

[simon-king-jena]

comment:47

Replying to @nexttime:

There's also #sagemath on freenode. Just saying...

Meaning what?