[go: up one dir, main page]

File: __init__.py

package info (click to toggle)
sclapp 0.5.3-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 316 kB
  • ctags: 466
  • sloc: python: 2,961; makefile: 35
file content (122 lines) | stat: -rw-r--r-- 3,398 bytes parent folder | download | duplicates (4)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# Copyright (c) 2005-2007 Forest Bond.
# This file is part of the sclapp software package.
# 
# sclapp is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License version 2 as published by the Free
# Software Foundation.
# 
# A copy of the license has been included in the COPYING file.

'''An easy-to-use framework for python command line applications.'''

# XXX: This work-around causes darwin to use the LC_* and LANG environment
# variables as on other Unix-like systems.  Without this,
# locale.getpreferredencoding always returns "mac-roman".  See:
#
#  http://www.selenic.com/mercurial/wiki/index.cgi/Character_Encoding_On_OSX

import sys

if sys.platform == 'darwin':
    sys.platform = 'generic'
    import locale
    sys.platform = 'darwin'
else:
    import locale

__all__ = (
  '__version__',
  # from sclapp.exceptions:
  'CriticalError',
  'UsageError',
  'SignalError',
  'ExitSignalError',
  # from sclapp.protected_output:
  'protectOutput',
  'unprotectOutput',
  # from sclapp.error_output:
  'printDebug',
  'printInfo',
  'printWarning',
  'printError',
  'printCritical',
  'setErrorOutputLevel',
  'ALL',
  'SCLAPP_DEBUG',
  'DEBUG',
  'INFO',
  'WARNING',
  'ERROR',
  'CRITICAL',
  # from sclapp.signals:
  'getExitSignals',
  'getNotifySignals',
  'getDefaultSignals',
  'getIgnoreSignals',
  'getCaughtSignals',
  'enableSignalHandling',
  'disableSignalHandling',
  'ALL_SIGNALS',
  'STD_EXIT_SIGNALS',
  'STD_NOTIFY_SIGNALS',
  'STD_DEFAULT_SIGNALS',
  'STD_IGNORE_SIGNALS',
  # from sclapp.main:
  'mainWrapper',
  'main_function',
  'makeSubCommandMain',
  # public sub-modules:
  'daemonize',
  'processes',
  'redirection',
  'termcontrol',
  'services',
  'stdio_encoding',
  'shinterp',
  # Allow callers to import locale from sclapp (see work-around above):
  'locale',
)

from sclapp.main import mainWrapper, main_function, makeSubCommandMain
from sclapp import termcontrol, services, daemonize, processes, redirection, \
  stdio_encoding, shinterp
  
try:
    import shell
except ImportError:
    pass
else:
    __all__ = __all__ + ('shell',)

from sclapp.exceptions import CriticalError, UsageError, SignalError, \
  ExitSignalError
from sclapp.protected_output import protectOutput, unprotectOutput
from sclapp.error_output import printDebug, printInfo, printWarning, \
  printError, printCritical, setErrorOutputLevel, \
  ALL, SCLAPP_DEBUG, DEBUG, INFO, WARNING, ERROR, CRITICAL
from sclapp.signals import getExitSignals, getNotifySignals, \
  getDefaultSignals, getIgnoreSignals, getCaughtSignals, \
  enableSignalHandling, disableSignalHandling, \
  ALL_SIGNALS, STD_EXIT_SIGNALS, STD_NOTIFY_SIGNALS, STD_DEFAULT_SIGNALS, \
  STD_IGNORE_SIGNALS
from sclapp import signals

try:
    from sclapp import version
except ImportError:
    __version__ = '0.0.0'
else:
    __version__ = version.version

def debug():
    '''Causes sclapp to enter debug mode.  Currently, this means that sclapp
    will wrap it's signal handlers with the logWrapper() function from the
    sclapp.debug_logging module.
    '''
    from sclapp.debug_logging import logWrapper
    signals._exitSignalHandler = logWrapper(
      signals._exitSignalHandler)
    signals._notifySignalHandler = logWrapper(
      signals._notifySignalHandler)
    signals._ignoreExitSignalHandler = logWrapper(
      signals._ignoreExitSignalHandler)