IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

#71: If a decoding error occurs in source files, print a warning and replace the characters by "?".

Browse Source
This commit is contained in:
Georg Brandl 2009-02-21 19:58:52 +01:00
parent 050560217c
commit 2d0345a7d9
2 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -1,6 +1,9 @@
Release 0.5.2 (in development) Release 0.5.2 (in development)
============================== ==============================
* #71: If a decoding error occurs in source files, print a
warning and replace the characters by "?".
* Fix a problem in the HTML search if the index takes too long * Fix a problem in the HTML search if the index takes too long
to load. to load.

21
sphinx/environment.py
View File

@ -14,6 +14,7 @@ import os
import time import time
import heapq import heapq
import types import types
import codecs
import imghdr import imghdr
import difflib import difflib
import cPickle as pickle import cPickle as pickle
@ -496,6 +497,21 @@ class BuildEnvironment:
# --------- SINGLE FILE READING -------------------------------------------- # --------- SINGLE FILE READING --------------------------------------------
def warn_and_replace(self, error):
"""
Custom decoding error handler that warns and replaces.
"""
linestart = error.object.rfind('\n', None, error.start)
lineend = error.object.find('\n', error.start)
if lineend == -1: lineend = len(error.object)
lineno = error.object.count('\n', 0, error.start) + 1
self.warn(self.docname, 'undecodable source characters, '
'replacing with "?": %r' %
(error.object[linestart+1:error.start] + '>>>' +
error.object[error.start:error.end] + '<<<' +
error.object[error.end:lineend]), lineno)
return (u'?', error.end)
def read_doc(self, docname, src_path=None, save_parsed=True, app=None): def read_doc(self, docname, src_path=None, save_parsed=True, app=None):
""" """
Parse a file and add/update inventory entries for the doctree. Parse a file and add/update inventory entries for the doctree.
@ -521,7 +537,12 @@ class BuildEnvironment:
self.docname = docname self.docname = docname
self.settings['input_encoding'] = self.config.source_encoding self.settings['input_encoding'] = self.config.source_encoding
codecs.register_error('sphinx', self.warn_and_replace)
class SphinxSourceClass(FileInput): class SphinxSourceClass(FileInput):
def decode(self_, data):
return data.decode(self_.encoding, 'sphinx')
def read(self): def read(self):
data = FileInput.read(self) data = FileInput.read(self)
if app: if app: