Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

Re^4: Why eval $version?

by syphilis (Archbishop)
on Jul 09, 2020 at 03:31 UTC ( [id://11119061]=note: print w/replies, xml ) Need Help??


in reply to Re^3: Why eval $version?
in thread Why eval $version?

One can use _ as delimiter in long literal numbers but not when numifying strings

Yes- that's pretty much the point I was making.
However, I wasn't sure if the need to eval comes about solely by introducing an underscore, so I chose to specify the strings that don't require eval rather than the strings that do.
I had wondered whether eval might also cater for version strings that contain multiple decimal points (v-strings), but a quick check suggests that's not the case. (Someone please let me know if I've got that wrong.)

Cheers,
Rob

Replies are listed 'Best First'.
Re^5: Why eval $version?
by LanX (Saint) on Jul 09, 2020 at 13:00 UTC
    > I had wondered whether eval might also cater for version strings that contain multiple decimal points (v-strings),

    The last part of dagolden's summary recommends to avoid dotted-integer versions

    Given these criteria, my recommendation is to use decimal version numbers, put them in quotes, and add a string eval:

    our $VERSION = "0.001"; $VERSION = eval $VERSION;

    This is safe and effective and always works. By putting any $VERSION in quotes, even if it isn’t an alpha, you don’t have to remember to add them if you ever change to an alpha version. (And numbers with trailing zeroes are nicely formatted when parsed for distribution versions.)

    If you really want to have a dotted-integer module version, then I strongly recommend that you limit your module to Perl 5.10 (or require version.pm and at least Perl 5.8.1) and that you never use an alpha version number. Always quote your dotted integer version when you define it and always use a leading-v to guide your users towards proper usage.

    It’s unfortunate that version numbers are so complicated in Perl, but if you follow the recommendations in this article, your version numbers will be as boring as possible. And if you’ve read this all the way to the end, I hope I’ve convinced you that ‘boring’ version numbers are exactly what you want.

    Cheers Rolf
    (addicted to the Perl Programming Language :)
    Wikisyntax for the Monastery

      our $VERSION = "0.001"; $VERSION = eval $VERSION;

      The thing I don't like about this is that (depending upon the original string), you might find that, after the eval is done, "$VERSION" ne <original_string>
      No such problem with "0.001", but consider this simple script:
      use strict; use warnings; my $str = "2.30"; our $VERSION = $str; $VERSION = eval $VERSION; print "WTF\n" if $VERSION ne $str;
      That outputs "WTF".
      That is, having assigned the string "2.30" to $VERSION, the eval forces $VERSION into a state where it stringifies to something other than "2.30" - namely to "2.3".

      It's probably of little importance, but I found it annoying enough to immediately replace all occurrences of eval $VERSION in my .pm files with #eval $VERSION
      I've no regrets about having done that, yet.

      Notably, with the eval removed, we can then perform both numeric and string comparisons reliably:
      use strict; use warnings; my $str = "2.30"; our $VERSION = $str; print "OK 1\n" if $VERSION == 2.3; print "OK 2\n" if $VERSION == $str; print "OK 3\n" if $VERSION eq $str; print $VERSION, " ", $str, "\n"; print "$VERSION $str\n"; __END_ outputs: OK 1 OK 2 OK 3 2.30 2.30 2.30 2.30
      I find that saner and preferable ... though I now always avoid using version strings that terminate with one or more zeros ... just in case ;-)

      Cheers,
      Rob

        The generally recommended practice now is to use $VERSION =~ tr/_//d; rather than $VERSION = eval $VERSION. This removes the underscores, but leaves trailing zeros intact. This also only applies if you are using numeric versions (rather than three part versions like v1.2.3) and are using underscores to denote developer releases. Using -TRIAL releases is another option that many prefer rather than using underscores.

        Hi

        2 things

        • make-maker and other tools are statically parsing perl files for $VERSION = "numberwang" so your example with $str won't work.
        • the comparison is supposed to be numeric, it's no surprise that string comparison will often fail on numbers! Just try sort 8..12 to see what I mean. °

        I'm afraid make-maker is keeping us stuck with $VERSION syntax for backwards compatibility.

        see also davido's research: Re: Why eval $version?

        But I could imagine a module Version::Smart exporting a tied object in $VERSION which DWIM.

        Though I'm wary of XKCD's standards ...

        Cheers Rolf
        (addicted to the Perl Programming Language :)
        Wikisyntax for the Monastery

        Update

        °) yes I know, since it's quoted it looks like a string

Re^5: Why eval $version?
by LanX (Saint) on Jul 09, 2020 at 13:20 UTC
    I read dagolden's article thrice and my head keeps smoking because of the confusion.

    • I was wondering if this confusion could be fixed with a new keyword version which accepts all formats and converts them.

      Then I realized that numerous tools statically parse .pl/.pm files for $VERSION

    • My next idea was to introduce magic var $VERSION acting like version (kind of tied scalar) and being automatically part of the package (hence no our required)

      Not sure if that's feasable.

    • My last idea was to look for advice in defining standards ...

      (... head has finished smoking, brain is ready to serve now!)

    Cheers Rolf
    (addicted to the Perl Programming Language :)
    Wikisyntax for the Monastery

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://11119061]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others sharing their wisdom with the Monastery: (5)
As of 2024-04-24 08:42 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found