views:

1400

answers:

9

There exist static analysis tools for Python, but compile time checks tend to be diametrically opposed to the run-time binding philosophy that Python embraces. It's possible to wrap the standard Python interpreter with a static analysis tool to enforce some "use strict"-like constraints, but we don't see any widespread adoption of such a thing.

Is there something about Python that makes "use strict" behavior unnecessary or especially undesirable?

Alternatively, is the "use strict" behavior unnecessary in Perl, despite its widespread adoption?

Note: By "necessary" I mean "practically necessary", not strictly necessary. Obviously you can write Perl without "use strict," but (from what I've seen) most Perl programmers do use it.

Note: The Python interpreter-wrapper need not require "use strict"-like constraints -- you could use a pseudo-pragma similar to "use strict" that would be ignored by the normal interpreter. I'm not talking about adding a language-level feature.


Update: Explaining what "use strict" does in Perl per comments. (Link to official docs is in the first paragraph.)

The "use strict" directive has three distinct components, only two of which are really interesting:

  • use strict vars: Statically checks lexically scoped variable usage in your program. (Keep in mind that, in Python, there is basically only global scope and local scope). Many Python linters check for this sort of thing. Since it's the only static analysis that they can do, the linters assume you use straightforward lexical scoping and warn you about things that appear wrong in that sense until you tell them to shut up; i.e.

    FOO = 12
    foo += 3
    

    If you're not doing anything fancy with your namespaces this can be useful to check for typos.

  • use strict refs: Prevents symbolic namespace dereferencing. Python's closest analog is using locals() and globals() to do symbolic binding and identifier lookup.

  • use strict subs: No real analog in Python.

A: 

It seems like the ideal of "Pythonic" code serves a lot of the same purpose as use strict.

Hank Gay
Can you elaborate on what that means, exactly? "use strict" is well defined, but "Pythonic" has a number of implications that aren't well documented and are somewhat subjective. "import this" is not sufficient explanation. ;-)
cdleary
As bobince explains in depth, Python strives to have only one clear way of doing things, so Python never allowed a lot of the constructs that Perl allows but `use strict` does not.
Hank Gay
+7  A: 

Python does have something that can change script syntax:

from __future__ import print_function

and various other future-features that have syntax implications. It's just that Python's syntax has been stricter, stabler and more well-defined than historical Perl; the kind of things that ‘strict refs’ and ‘strict subs’ prohibit have never existed in Python.

‘strict vars’ is primarily intended to stop typoed references and missed-out ‘my’s from creating accidental globals (well, package variables in Perl terms). This can't happen in Python as bare assignments default to local declaration, and bare unassigned symbols result in an exception.

(There is still the case where users accidentally try to write-through to a global without declaring it with a ‘global’ statement, causing either an accidental local or, more often, an UnboundLocalError. This tends to be learned fairly quickly, but it is an arguable case where having to declare your locals could help. Although few experienced Python programmers would accept the readability burden.)

Other language and library changes that do not involve syntax are handled through the warnings system.

bobince
I like where this answer is going. I figured that using globals()[] or locals()[] would be similar to strict refs, although I agree on strict subs. It seems like there a need for checking in the typo department, though -- why haven't people fallen all over static analysis tools to check their typos?
cdleary
+3  A: 

I consider the 'use strict' in Perl more like a pragma as you hinted at: it changes the behavior of the compiler.

Perl language philosophy is different from python philosophy. As in, you are given more than enough rope to hang yourself repeatedly, in Perl.

Larry Wall is big into linguistics, so we have from Perl what is referred to as the TIMTOWTDI (say tim-toe-dee) principle vs. Zen of python:

There should be one-- and preferably only one --obvious way to do it.

you could very easily use pylint and PyChecker to come up with your own flavor of use strict for python (or something analogous to perl -cw *scriptname*) but because of the different philosophies in the language design, you will not encounter this in practice widely.

Based on your comment to the first poster, you are familiar with python's import this. There are a lot of things in there which illuminate why you do not see an equivalent of use strict in Python. If you meditate on the koan found in the Zen of Python, you may find enlightenment for yourself. :)

popcnt
I was hoping I wouldn't see an answer telling me to "import this" without giving a real explanation. How would a compiler that checks identifier scoping violate the Pythonic Theses? How does runtime lookup make static lexical analysis sufficiently useless? We know the philosophies are different.
cdleary
f you have a less-advnaced editor which will not help you uncover ill-named variables (in both perl or python, or whatever) or prevent them in the first place, then there may be a positive benefit to static lexical analysis. pylint and PyChecker would seem to adequately cover this space?
popcnt
Yes, so my question is whether there is a need for a compiler that automatically invokes this kind of static analysis if you give it a directive, and why/why not. Also, which editors are you referring to? Surely you don't auto-complete *every* variable name no matter which editor you're using.
cdleary
@cdleary: emacs - and yes, i do auto-complete on every variable (except the first time of course), and I love it!
popcnt
@popcnt: Interesting -- I feel like that would actually slow down my typing, having to verify and/or select the autocomplete every time. Does it slow you down at all?
cdleary
A: 

I don't have a Perl background, but from what I know, there's no feature in python that needs to be disabled in order for your code to be "more reliable", so in that sense, I guess you can say it's unnecessary

hasen j
+11  A: 
S.Lott
Your answer pretty much amounts to, "It just isn't necessary." I understand that lots of Python code has been written successfully without it -- I'm asking for us to introspect on *why* we don't need it and, relatedly, why Perl programmers think they do need it.
cdleary
last verse contains a shorter explanation from the Zen of Python once again (on why static compile-time checking like 'use strict' would never work with python): Namespaces are one honking great idea -- let's do more of those!
popcnt
Again, "use strict" is not a static compile-time check.
mpeters
Yet, the question specifically says "There exist static analysis tools for Python, but..." so I'm lumping static analysis, as mentioned specifically in the question, along with the additional dynamic checks of use strict. In keeping with the original post.
S.Lott
@mpeters: use strict at least has components which are compile time checks (use strict vars), which are clearly performed via static analysis.
cdleary
@S.Lott: Thanks for expounding. Devil's advocate: some program incorrectness is easier to detect than others. I'm not saying we should statically type, but we *can* do static analysis of lexically scoped identifiers in a file (not attributes), thus preventing our program from inevitably bombing out.
cdleary
@cdleary: I'll assume you're talking about magically detecting misspellings of identifiers in Python. If your unit tests don't reveal the uninitialized variables or misspelled method or function names, you have bigger issues that static checking cannot hope to resolve.
S.Lott
@S.Lott: Most people who write "scripts" (in the strict sense) don't write unit tests, usually because of lots of side-effecty I/O. Unit tests make sense for application/framework programming, but for scripting scenarios a compiler flag to check identifiers seems useful, no?
cdleary
@cdleary: Undefined identifiers already raise a run-time exception. That was easy. Anything else we can check for?
S.Lott
@S.Lott: Right, but you don't want to be half way through one of the aforementioned scripts and have it bomb out because of a NameError that you could have detected at compile time, right? Is it useful to have an interpreter-wrapper that optionally runs this analysis at compile time?
cdleary
@cdleary: Running an untested script that can do damage is not a use case I can imagine. I can't get past the "you want to run without testing?!?!?" part of this example.
S.Lott
@S.Lott: Fair enough -- I find that part hard to understand as well, though I've known people to insist that testing and scripting were somehow at odds.
cdleary
@cdleary: anyone who claims testing and scripting are at odds is simply refusing to test. They need to start a different career, far away from software.
S.Lott
+5  A: 

Python has no true lexical scoping, so strict vars wouldn't be very sensible. It has no symbolic references AFAIK, so it has not need for strict refs. It has not barewords, so it has no need for strict vars.

To be honest, it's only lexical scoping I miss. The other two I'd consider warts in Perl.

Leon Timmermans
attribute with double underbar (obj.__attr) do not count as lexical scoping to you?
popcnt
Attributes have little to do with lexical scoping.
Leon Timmermans
What do you mean? Python clearly has lexical scoping (at least since 2.1), but I don't see that it has much to do with requiring strict declarations. Are you referring to something else by this?
Brian
Yes, Python is lexically scoped. I think is referring to the fact a new lexical scope is only created with some particular constructs: modules, classes, and functions. i.e. for loops don't have an independent enclosing scope. If you bind an identifier inside a for loop it stays bound outside of it.
cdleary
@cdleary: yeah, that's what I meant.
Leon Timmermans
python does name mangling with double-underbar attributes-- that name is visible only to objects of that class. +you can create closures in python, so independent enclosing scope. e.g. http://stackoverflow.com/questions/604622/does-python-have-something-like-perl-5-10s-state-variables/604945#604945
popcnt
@Leon oh, i think i see now -- you appreciate the nested lexical scoping of perl, which you miss in python. i guess that is a matter of taste :) i was trying to point out some analogous things in python which have similar effects/results.
popcnt
+5  A: 

I think there's some confusion as the what "use strict" does, from the comments I'm seeing. It does not turn on compile time type checks (to be like Java). In that sense, Perl progammers are in agreement with python programmers. As S.Lott says above these types of checks don't protect against logic bugs, don't reduce the number of unit tests you need to write and we're also not big fans of bondage programming.

Here's a list of what "use strict" does do:

  1. Using symbolic references is a run-time error. This prevents you from doing crazy (but sometimes useful things like)

    $var = 'foo';

    $foo = 'bar';

    print $$var; # this would contain the contents of $foo unless run under strict

  2. Using undeclared variables is a run-time error (this means you need to use "my", "our" or "local" to declare your variable's scope before using it.

  3. All barewords are considered compile-time syntax errors. Barewords are words that have not been declared as symbols or subroutines. This is mainly to outlaw something that was historically done but is considered to have been a mistake.

mpeters
+15  A: 

Well, I'm not much of a python programmer, but I'd say that the answer is 'YES'.

Any dynamic language that lets you create a variable with any name at any time, could use a 'strict' pragma.

Strict vars (one of the options for strict in Perl, 'use strict' turns them all on at once) in Perl requires that all variables are declared before they are used. Which means that this code:

my $strict_is_good = 'foo';
$strict_iS_good .= 'COMPILE TIME FATAL ERROR';

Generates a fatal error at compile time.

I don't know of a way to get Python to reject this code at compile time:

strict_is_good = 'foo';
strict_iS_good += 'RUN TIME FATAL ERROR';

You will get a run-time exception that strict_iS_good is undefined. But only when the code is executed. If your test suite does not have 100% coverage, you can easily ship this bug.

Any time I work in a language that does not have this behavior (PHP for example), I get nervous. I am not a perfect typist. A simple, but hard to spot, typo can cause your code to fail in ways that may be hard to track down.

So, to reiterate, YES Python could use a 'strict' pragma to turn on compile time checks for things that can be checked at compile time. I can't think of any other checks to add, but a better Python programmer probably could think of some.

Note I focus on the pragmatic effect of stict vars in Perl, and am glossing over some of the details. If you really want to know all the details see the perldoc for strict.

Update: Responses to some comments

Jason Baker : Static checkers like pylint are useful. But they represent an extra step that can be and often is skipped. Building some basic checks into the compiler guarantees that these checks are performed consistently. If these checks are controllable by a pragma, even the objection relating to the cost of the checks becomes moot.

popcnt : I know that python will generate a run time exception. I said as much. I advocate compile time checking where possible. Please reread the post.

mpeters : No computer analysis of code can find all errors--this amounts to solving the halting problem. Worse, to find typos in assignments, your compiler would need to know your intentions and find places where your intentions differ from your code. This is pretty clearly impossible.

However this does not mean that no checking should be done. If there are classes of problems that are easy to detect, then it makes sense to trap them.

I'm not familiar enough with pylint and pychecker to say what classes of errors they will catch. As I said I am very inexperienced with python.

These static analysis programs are useful. However, I believe that unless they duplicate the capabilities of the compiler, the compiler will always be in a position to "know" more about the program than any static checker could. It seems wasteful not to take advantage of this to reduce errors where possible.

Update 2:

cdleary - In theory, I agree with you, a static analyzer can do any validation that the compiler can. And in the case of Python, it should be enough.

However, if your compiler is complex enough (especially if you have lots of pragmas that change how compilation occurs, or if like Perl, you can run code at compile time), then the static analyzer must approach the complexity of the compiler/interpreter to do the analysis.

Heh, all this talk of complex compilers and running code at compile time shows my Perl background.

My understanding is that Python does not have pragmas and can not run arbitrary code at compile time. So, unless I am wrong or these features are added, a relatively simple parser in the static analyzer should suffice. It certainly would be helpful to force these checks at every execution. Of course, the way I'd do this is with a pragma.

Once you add pragmas to the mix, you have started down a slippery slope and the complexity of you analyzer must grow in proportion to the power and flexibility you provide in your pragmas. If you are not careful, you can wind up like Perl, and then "only python can parse Python," a future I wouldn't want to see.

Maybe a command line switch would be a better way to add forced static analysis ;)

(In no way do intend to impugn Python's capabilities when I say that it can't futz with compile time behavior like Perl can. I have a hunch that this is a carefully considered design decision, and I can see the wisdom in it. Perl's extreme flexibility at compile time is, IMHO, a great strength and a terrible weakness of the language; I see the wisdom in this approach as well.)

daotoad
There are static checkers like pylint and pychecker that can do this for you.
Jason Baker
python DOES "reject" the code to use your terminology, but at run-time. a decent editor will help to avoid such mistakes, in both perl and python-- which is the point -> avoid including unintended errors in your source code.
popcnt
see this example from python:>>> strict_is_for_those_with_worthless_code_editors = 'yes'>>> strict_Is_god += 'RUN TIME FATAL ERROR'Traceback (most recent call last): File "<stdin>", line 1, in ?NameError: name 'strict_Is_god' is not defined>>>
popcnt
but this doesn't catch typos in your assignment. What if you change the value of a variable later on in your code but you typo'd the name. It wouldn't be caught by the interpreter at runtime. Would pylint or pychecker catch it?
mpeters
@Jason Baker: Yes, part of the question is why we don't distribute a version of the Python interpreter with a PyChecker static analysis check flag to find this kind of thing at compile time.
cdleary
I disagree with the last part of your edit - the static (lexical) analysis that the compiler could perform is identical to a third party inspection of the syntax. This AST functionality is also in the stdlib. The Python compiler just converts a valid syntax tree into stack-machine bytecode.
cdleary
Python can compile/run arbitrary code at runtime. Check out eval ( http://docs.python.org/library/functions.html#eval ). Python has pragmas. See __future__ bitflags ( http://docs.python.org/library/__future__.html?highlight=__future__#module-__future__ )
cdleary
Evals make static analysis impossible. We generally don't care about static checking if we use eval - most static checkers will give up if they see one. I'm only talking about optional, per-file, compile-time, scope-based syntax checking in the OP. A subset of what PyLint/PyFlakes do.
cdleary
A: 

I've found that I only really care about detecting references to undeclared vars. Eclipse has pylint integration via PyDev and, although pylint is far from perfect, it does a reasonable job at that.

It does kind of go against Python's dynamic nature, and I do have to add #IGNOREs occasionally, when my code gets clever about something. But I find that happens infrequently enough that I'm happy with it.

But I could see the utility of some pylint-like functionality becoming available in the form of a command-line flag. Kind of like Python 2.6's -3 switch, which identifies points of incompatibility between Python 2.x and 3.x code.

DNS
Yeah, this is along the lines I was thinking as well -- wrap the regular interpreter with an additional flag to turn on "use strict" compilation. I've never seen anything like this, but Perl thinkers tend to consider it necessary/desirable. Python thinkers tend not to care. Why don't we care?
cdleary