Beefy Boxes and Bandwidth Generously Provided by pair Networks
Don't ask to ask, just ask
 
PerlMonks  

Re^3: Warnings on unused variables?

by ikegami (Patriarch)
on Sep 27, 2008 at 18:27 UTC ( [id://714044]=note: print w/replies, xml ) Need Help??


in reply to Re^2: Warnings on unused variables?
in thread Warnings on unused variables?

I would not have considered cases 2, 3 or 6 false positives

Why not? A warning would be issued for complete, accurate, functioning code. That's the very definition of a false positive.

#2 ignores one of the function's return values. There are other ways of doing it, but there's nothing wrong with that way.

#3 implements creates an empty file.

#6 is used in creating inside out objects.

#1 uses $foo++

No. As far as Perl is concerned, '$foo++' might as well be 'print "Hello World"' when the program is compiled. $foo is only seen long after the warning has been issued, when the eval is executed.

#4 in theory will see $lock checked at least once inside do_stuff_that_needs_the_lock()

No. It's not passed to do_stuff_that_needs_the_lock (which would be using it twice).

#5 passes $tree to new()

Yeah, but what about $sentinel?

#4 and #5 are both examples of Resource Acquisition Is Initialization objects where the functionality exists solely in the constructor and the (implicitly called) destructor.

Replies are listed 'Best First'.
Re^4: Warnings on unused variables?
by AZed (Monk) on Sep 27, 2008 at 21:19 UTC

    Mhm, either you and I have different definitions of 'accurate', or we have different conceptions about what constitutes a useful warning. I want warnings on code that, especially if handed to someone who didn't write it, is more likely than equivalent code that doesn't generate the warning to become the seed of a future bug. To me, a warning says, "Okay, well, yes, you can technically do it that way, but it's likely to be better in the long run if you do something else."

    Specifics follow the jump.

      I just tested that #1 in fact does use $foo++, and warnings::unused handles it properly

      You forgot about tied variables. $foo++ can be tied to code that prints out "Hello World" as a side effect.

      I guess the short version of this is, I don't see any situation where using a declare-once-and-forget variable is ever clearer or substantially more efficient than an alternative, so I don't see any of these situations as warranting exceptions from warnings, even if they are in common use.

      You haven't programmed much with resource acquisition/release systems then. C has lots of problems with that, Windows COM has lots of problems with that and Perls reference counting also has these problems (although many of them have been fixed in all instances). With Reference Counting as the instance of resource acquisition and release, you have exactly the problem that the points of acquisition (increase of refcount) and release (decrement of refcount) are not in the same place of the code and hence, quite unpleasantly, not every acquisition is matched with a release, because it's hard to see that they match up because they do not happen in the same place. Which is why a "execute this code at scope exit" functionality is wanted.

        That's the point of resource acquisition/release, sure. Why is it clearer to allow it to silently happen at the closing brace than to explicitly release on the line before the closing brace? The issue isn't whether or not you've used a destructor with a special ability — it's whether you've done so in a way that isn't clear, and thus should trigger a warning.

        Also, does a tie matter? Would a tie have caused $foo++ cause warnings::unused to throw a warning?

        (I posted this comment earlier, but it seems to have disappeared. Apologies if this makes it show up twice.)

      #3 indicates a position where a filehandle was used for an open and never used again, not even to check return value on a close.

      close will never fail, cause all we want to do is create the file.

      It adds all of a dozen characters

      But that's a dozen of characters of unnecessary code. For just one line of code! I'd have useless code all over the place. Code that can do nothing but introduce errors, since it doesn't serve any function.

      and leaves the warnings valid for any time I had opened multiple files, and then accidentally used one of the file descriptors twice in a row instead of using the one I intended.

      No. Since you believe in closing everything explicitly, the warning won't help you there.

      # $fh1 $fh2 # ---- ---- open(my $fh1, '>', $file1) or die; # 1 open(my $fh2, '>', $file2) or die; # 1 for (@data) { # print $fh1 "$_\n"; # 1 print $fh1 "$_\n"; # Oops # 1 } # close($fh1); # 1 close($fh2); # 1 # ---- ---- # 4 2 -> no warnings

      Furthermore, autodie is a great module for testing errors on close, and it doesn't reference the file handle explicitly.

      I'm not sure why putting your locks in your constructor

      No, the constructor obtains the lock. The object is the lock.

      I would not personally use constructor methods named in such a way that they can be easily mistaken for procedures

      You've never used threads? And constructors are routinely called names other than new.

      I'm not sure why [RAII] is substantially better [...] explicitly locking the object until it passes out of scope.

      To properly release the lock when an exception occurs or when return is used more than once.

      but I'd argue that this is exactly why I want a warning on code that looks like that.

      I'd rather avoid doing away with exceptions, I'd rather my code doesn't throw spurious warnings, and I'd rather not have to us no warnings; all over the place. That's why it's better checked by a linter or until turned on explicitly (meaning -v and use warnings; wouldn't enable it).

      You've hidden functionality inside a destructor-only event that is going to trigger many lines of code away from when you prepped it. I want a warning if someone does that.

      You say deallocation of resources on block exit worthy of a warning? Every single variable in Perl does that!

        close will never fail, cause all we want to do is create the file.

        In this situation, yes. This may not be true later.

        But that's a dozen of characters of unnecessary code. For just one line of code! I'd have useless code all over the place. Code that can do nothing but introduce errors, since it doesn't serve any function.

        No, you shouldn't need it more than once, because that's a corner case you can stick in a procedure. The final close serves the function of making missing filehandles visible elsewhere.

        Since you believe in closing everything explicitly, the warning won't help you there.

        Careful, that's not what I said. I believe in making sure that every variable that was intentionally not used gets used in such a way that it is marked, even via an unnecessary close call, exactly because it allows you to catch errors like this by turning on warnings::unused:

        I'd rather avoid doing away with exceptions, I'd rather my code doesn't throw spurious warnings

        Well, we obviously have a fundamental philosophical disagreement about what is spurious. It may not be important; I'm not sure a discussion of warning philosophy warrants exclamation points and so much node space, but I'll offer you this: if you can show me a code formation that is plausibly frequently found in a project, raises warnings under warnings::unused, and any changes that would result in the warnings going away also results in the code becoming significantly less clear or maintainable, I'll concede the point and try not to bring it up again. We can play code tennis: you post something that warns, but is otherwise clear, and I try to make it clearer and warning-free. Writing code can be fun (and I do intend to follow up on your question about the behaviour of warnings::unused in different scenarios, because it is code). This kind of essay isn't, really, so otherwise, since I'm obviously not in a position to mandate anything in the development of Perl 6, let's leave it at that.

        <tweetybirdvoice>Twoo-Love!</tweetybirdvoice>

      In to the other class of examples, I just tested that #1 in fact does use $foo++, and warnings::unused handles it properly:

      That's odd.
      Does eval '$'.'foo++' issue a warning for $foo? (It shouldn't)
      Does eval 'print q{$foo++}' issue a warning for $foo? (It should)
      Does eval '$cond ? $foo : $bar' issue a warning for $foo and $bar? (It shouldn't)

        Just tested, using the same code I used earlier, substituting in each new eval block one at a time without using exit(), i.e.:

        #!/usr/bin/perl use warnings; use warnings::unused; use strict; my $foo = 42; my $bar = 43; eval '$'.'foo++';

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others having a coffee break in the Monastery: (4)
As of 2024-04-25 17:50 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found