Suppose you are designing a new class with some methods that you don't want to implement, yet.
class MyClass(object):
def meth_a(self):
pass
def meth_b(self):
print "I'm meth_b"
If you were to leave out the pass, the code wouldn't run.
You would then get an:
IndentationError: expected an indented block
To summarize, the pass statement does nothing particular, but it can act as a placeholder, as demonstrated here.
Videos
Suppose you are designing a new class with some methods that you don't want to implement, yet.
class MyClass(object):
def meth_a(self):
pass
def meth_b(self):
print "I'm meth_b"
If you were to leave out the pass, the code wouldn't run.
You would then get an:
IndentationError: expected an indented block
To summarize, the pass statement does nothing particular, but it can act as a placeholder, as demonstrated here.
Python has the syntactical requirement that code blocks (after if, except, def, class etc.) cannot be empty. Empty code blocks are however useful in a variety of different contexts, such as in examples below, which are the most frequent use cases I have seen.
Therefore, if nothing is supposed to happen in a code block, a pass is needed for such a block to not produce an IndentationError. Alternatively, any statement (including just a term to be evaluated, like the Ellipsis literal ... or a string, most often a docstring) can be used, but the pass makes clear that indeed nothing is supposed to happen, and does not need to be actually evaluated and (at least temporarily) stored in memory.
Ignoring (all or) a certain type of
Exception(example fromxml):try: self.version = "Expat %d.%d.%d" % expat.version_info except AttributeError: pass # unknownNote: Ignoring all types of raises, as in the following example from
pandas, is generally considered bad practice, because it also catches exceptions that should probably be passed on to the caller, e.g.KeyboardInterruptorSystemExit(or evenHardwareIsOnFireError– How do you know you aren't running on a custom box with specific errors defined, which some calling application would want to know about?).try: os.unlink(filename_larry) except: passInstead using at least
except Error:or in this case preferablyexcept OSError:is considered much better practice. A quick analysis of all Python modules I have installed gave me that more than 10% of allexcept ...: passstatements catch all exceptions, so it's still a frequent pattern in Python programming.Deriving an exception class that does not add new behaviour (e.g., in SciPy):
class CompileError(Exception): passSimilarly, classes intended as abstract base class often have an explicit empty
__init__or other methods that subclasses are supposed to derive (e.g.,pebl):class _BaseSubmittingController(_BaseController): def submit(self, tasks): pass def retrieve(self, deferred_results): passTesting that code runs properly for a few test values, without caring about the results (from
mpmath):for x, error in MDNewton(mp, f, (1,-2), verbose=0, norm=lambda x: norm(x, inf)): passIn class or function definitions, often a docstring is already in place as the obligatory statement to be executed as the only thing in the block. In such cases, the block may contain
passin addition to the docstring in order to say “This is indeed intended to do nothing.”, for example inpebl:class ParsingError(Exception): """Error encountered while parsing an ill-formed datafile.""" passIn some cases,
passis used as a placeholder to say “This method/class/if-block/... has not been implemented yet, but this will be the place to do it”, although I personally prefer theEllipsisliteral...in order to strictly differentiate between this and the intentional “no-op” in the previous example. (Note that the Ellipsis literal is a valid expression only in Python 3)For example, if I write a model in broad strokes, I might write
def update_agent(agent): ...where others might have
def update_agent(agent): passbefore
def time_step(agents): for agent in agents: update_agent(agent)as a reminder to fill in the
update_agentfunction at a later point, but run some tests already to see if the rest of the code behaves as intended. (A third option for this case israise NotImplementedError. This is useful in particular for two cases: Either “This abstract method should be implemented by every subclass, and there isn't a generic way to define it in this base class”, or “This function, with this name, is not yet implemented in this release, but this is what its signature will look like”)