Source.Python/docs/_modules/hooks/warnings.html at v742 · Source-Python-Dev-Team/Source.Python

History

183 lines (151 loc) · 12.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

<!DOCTYPE html>

<head>

<title>hooks.warnings — Source.Python v742 documentation</title>

</head><body>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v742 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">hooks.warnings</a></li>

</ul>

</div>

<h1>Source code for hooks.warnings</h1><div class="highlight"><pre>

# ../hooks/warnings.py

"""Provides warning hooking functionality."""

# =============================================================================

# >> IMPORTS

# =============================================================================

# Python Imports

# TextWrap

from textwrap import TextWrapper

# Warnings

import warnings

# Source.Python Imports

# Hooks

from hooks import _hooks_strings

from hooks import hooks_logger

from hooks.base import _HookBase

from hooks.base import _HookDecorator

from hooks.exceptions import except_hooks

# Paths

from paths import GAME_PATH

# =============================================================================

# >> ALL DECLARATION

# =============================================================================

__all__ = ('WarningHook',

'_WarningHooks',

'warning_hooks',

)

# =============================================================================

# >> GLOBAL VARIABLES

# =============================================================================

# Get the sp.hooks.warnings logger

hooks_warnings_logger = hooks_logger.warnings

# Get the TextWrapper instance to use for warnings

_text_wrapper = TextWrapper(80, subsequent_indent=' ' * 8)

# =============================================================================

# >> CLASSES

# =============================================================================

class _WarningHooks(_HookBase):

"""Class used to log warnings."""

def print_warning(

self, message, category, filename, lineno, file=None, line=None):

"""Called when a warning is encountered.

This method hooks :obj:`warnings.showwarning` to log all warnings

and call registered callbacks with the provided arguments.

"""

# Loop through each callback in the warning list

for callback in self:

# Try to call the callback

try:

# Call the callback

callback(message, category, filename, lineno)

# Was an error encountered?

except:

# Log the exception

except_hooks.print_exception()

# Get the message to log

print_message = '\n[SP] ' + _hooks_strings['Warning'].get_string()

# Add the warning to the message

print_message += "\n File '..{0}', line {1}: {2}\n {3}".format(

filename.replace(GAME_PATH, ''), lineno,

category.__name__, '\n'.join(_text_wrapper.wrap(str(message))))

# Log the warning

hooks_warnings_logger.log_warning(print_message + '\n')

# The singleton object of the :class:`_WarningHooks` class

warning_hooks = _WarningHooks()

# Set warnings.showwarning to the print_warning method

warnings.showwarning = warning_hooks.print_warning

# Set warnings to only appear once (the first occurrence)

warnings.filterwarnings('once')

class WarningHook(_HookDecorator):

"""Register/unregister a function/method for hooking warnings."""

_class_instance = warning_hooks</div>

</pre></div>

</div>

</a>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

>index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v742 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">hooks.warnings</a></li>

</ul>

</div>

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

warnings.html

Latest commit

History

warnings.html

File metadata and controls