aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/ipython/py2/IPython/utils/warn.py
blob: 831e4265acfe27a63aefc1d0f0e0c70666a5355e (plain) (blame)
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
# encoding: utf-8 
""" 
Utilities for warnings.  Shoudn't we just use the built in warnings module. 
""" 
 
# Copyright (c) IPython Development Team. 
# Distributed under the terms of the Modified BSD License. 
 
from __future__ import print_function 
 
import sys 
import warnings
 
warnings.warn("The module IPython.utils.warn is deprecated since IPython 4.0, use the standard warnings module instead", DeprecationWarning)
 
def warn(msg,level=2,exit_val=1): 
    """Deprecated
 
    Standard warning printer. Gives formatting consistency.
 
    Output is sent to sys.stderr.

    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.""" 
    
    warnings.warn("The module IPython.utils.warn is deprecated since IPython 4.0, use the standard warnings module instead", DeprecationWarning)
    if level>0: 
        header = ['','','WARNING: ','ERROR: ','FATAL ERROR: '] 
        print(header[level], msg, sep='', file=sys.stderr)
        if level == 4: 
            print('Exiting.\n', file=sys.stderr)
            sys.exit(exit_val) 
 
             
def info(msg): 
    """Deprecated 
    
    Equivalent to warn(msg,level=1)."""
 
    warn(msg,level=1) 
 
     
def error(msg): 
    """Deprecated 
    
    Equivalent to warn(msg,level=3)."""
 
    warn(msg,level=3) 
 
     
def fatal(msg,exit_val=1): 
    """Deprecated 
    
    Equivalent to warn(msg,exit_val=exit_val,level=4)."""
 
    warn(msg,exit_val=exit_val,level=4)