So is_url_sketchy() should not, say, delete a bunch of files. Therefore, the function should only take actions that one might expect given its name. Assume that all the other programmers knows is its name since they don't bother to read the documentation. is_url_sketchy(url), imagine that another programmer is writing code to call this function.

The Principle of Least Surprise is a convention for function names. It could be named bit.is_front_clear(), but that may not be enough of an improvement to merit adding another word.įunction Name - Principle Of Least Surprise The Bit function bit.front_clear() works well enough. Think about how the function call will read when used in an if or while: If a function returns a boolean value, starting its name with is_ or has_ can be a good choice. In Python, the sweet spot is probably one to three words, separated by underbars _, summarizing the main idea of the function. The name of a function does not need to spell out every true detail about it. Look at how the function names below make the surrounding code read nicely. Function names often use verbs indicating what calling the function will accomplish. Good function names are the first step in readable code. Readable code tends to be less buggy, since a bug is a case where what the code says literally diverges from what the author had in mind. The code 'reads' nicely, as the combination of function names and variable names narrate what it does. When someone looks at the code, what it does is apparent.

What is the best code? Different situations call for different goals, but an excellent all purpose goal for code is that it is readable.