FilesExpand file tree

 master

/

decorators.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

58 lines (44 loc) · 2.02 KB

 master

/

decorators.py

Copy path

Top

File metadata and controls

• Code
• Blame

58 lines (44 loc) · 2.02 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

# encoding: utf-8

"""Decorators that don't go anywhere else.

This module contains misc. decorators that don't really go with another module

in :mod:`IPython.utils`. Beore putting something here please see if it should

go into another topical module in :mod:`IPython.utils`.

"""

#-----------------------------------------------------------------------------

# Copyright (C) 2008-2011 The IPython Development Team

#

# Distributed under the terms of the BSD License. The full license is in

# the file COPYING, distributed as part of this software.

#-----------------------------------------------------------------------------

#-----------------------------------------------------------------------------

# Imports

#-----------------------------------------------------------------------------

#-----------------------------------------------------------------------------

# Code

#-----------------------------------------------------------------------------

def flag_calls(func):

"""Wrap a function to detect and flag when it gets called.

This is a decorator which takes a function and wraps it in a function with

a 'called' attribute. wrapper.called is initialized to False.

The wrapper.called attribute is set to False right before each call to the

wrapped function, so if the call fails it remains False. After the call

completes, wrapper.called is set to True and the output is returned.

Testing for truth in wrapper.called allows you to determine if a call to

func() was attempted and succeeded."""

# don't wrap twice

if hasattr(func, 'called'):

return func

def wrapper(*args,**kw):

wrapper.called = False

out = func(*args,**kw)

wrapper.called = True

return out

wrapper.called = False

wrapper.__doc__ = func.__doc__

return wrapper

def undoc(func):

"""Mark a function or class as undocumented.

This is found by inspecting the AST, so for now it must be used directly

as @undoc, not as e.g. @decorators.undoc

"""

return func