FilesExpand file tree

 master

/

warn.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

81 lines (58 loc) · 2.48 KB

 master

/

warn.py

Copy path

Top

File metadata and controls

• Code
• Blame

81 lines (58 loc) · 2.48 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

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

# encoding: utf-8

"""

Utilities for warnings. Shoudn't we just use the built in warnings module.

"""

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

# 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

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

from __future__ import print_function

import sys

import warnings

from IPython.utils import io

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

# Code

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

def warn(msg,level=2,exit_val=1):

"""Standard warning printer. Gives formatting consistency.

Output is sent to io.stderr (sys.stderr by default).

Options:

-level(2): allows finer control:

0 -> Do nothing, dummy function.

1 -> Print message.

2 -> Print 'WARNING:' + message. (Default level).

3 -> Print 'ERROR:' + message.

4 -> Print 'FATAL ERROR:' + message and trigger a sys.exit(exit_val).

-exit_val (1): exit value returned by sys.exit() for a level 4

warning. Ignored for all other levels."""

if level>0:

header = ['','','WARNING: ','ERROR: ','FATAL ERROR: ']

print(header[level], msg, sep='', file=io.stderr)

if level == 4:

print('Exiting.\n', file=io.stderr)

sys.exit(exit_val)

def info(msg):

"""Equivalent to warn(msg,level=1)."""

warn(msg,level=1)

def error(msg):

"""Equivalent to warn(msg,level=3)."""

warn(msg,level=3)

def fatal(msg,exit_val=1):

"""Equivalent to warn(msg,exit_val=exit_val,level=4)."""

warn(msg,exit_val=exit_val,level=4)

def DeprecatedClass(base, class_name):

# Hook the init method of the base class.

def init_hook(self, *pargs, **kwargs):

base.__init__(self, *pargs, **kwargs)

# Warn once per class.

if base not in DeprecatedClass._warned_classes:

DeprecatedClass._warned_classes.append(base)

warn('"{}" is deprecated, please use "{}" instead.'.format(

class_name, base.__name__))

return type(class_name, (base,), {'__init__': init_hook})

DeprecatedClass._warned_classes = []