Logging Leave feedback
On this page
GroupDocs.Parser can report the errors, warnings and events that occur while it extracts data. Pass a logger to ParserSettings and the settings to the Parser constructor. The logger can be:
| Logger | Called as |
|---|---|
| A function | log(level, message, exception), where level is "trace", "warning" or "error", and exception is the text of the .NET exception or None |
| An object | trace(message), warning(message) and error(message, exception); a method the object does not define is skipped |
Here are the steps to receive the information with a function:
- Define a function that takes
level,messageandexception; - Create
ParserSettingswith the function; - Instantiate the
Parserobject with the settings.
from groupdocs.parser import Parser
from groupdocs.parser.exceptions import InvalidPasswordException
from groupdocs.parser.options import ParserSettings
def log(level, message, exception):
# level is "trace", "warning" or "error";
# exception is the text of the .NET exception, or None
print("%s: %s" % (level.capitalize(), message))
try:
# Open a protected document without its password
with Parser("./protected.pdf", ParserSettings(log)) as parser:
print(parser.get_text())
except InvalidPasswordException:
print("The document is password-protected.")
The following sample file is used in this example: protected.pdf
ERROR groupdocs.parser: Exception of type 'GroupDocs.Parser.Exceptions.InvalidPasswordException' was thrown.
INFO groupdocs.parser: Skipped a protected document
Expected behavior: The logger reports the error before the exception reaches your code:
Error: Exception of type 'GroupDocs.Parser.Exceptions.InvalidPasswordException' was thrown.
The document is password-protected.
An object with trace, warning and error methods works too, the shape of the .NET ILogger interface:
from groupdocs.parser import Parser
from groupdocs.parser.exceptions import InvalidPasswordException
from groupdocs.parser.options import ParserSettings
class Logger:
def trace(self, message):
# Print event message
print("Event: " + message)
def warning(self, message):
# Print warning message
print("Warning: " + message)
def error(self, message, exception):
# Print error message
print("Error: " + message)
try:
with Parser("./protected.pdf", ParserSettings(Logger())) as parser:
print(parser.get_text())
except InvalidPasswordException:
pass # The logger has already reported it
The following sample file is used in this example: protected.pdf
Error: Exception of type 'GroupDocs.Parser.Exceptions.InvalidPasswordException' was thrown.
Expected behavior: Prints Error: Exception of type 'GroupDocs.Parser.Exceptions.InvalidPasswordException' was thrown.
Map the three levels onto the standard logging levels to route the engine’s messages to your application’s handlers:
import logging
import sys
from groupdocs.parser import Parser
from groupdocs.parser.exceptions import InvalidPasswordException
from groupdocs.parser.options import ParserSettings
logging.basicConfig(stream=sys.stdout, level=logging.DEBUG,
format="%(levelname)s %(name)s: %(message)s")
logger = logging.getLogger("groupdocs.parser")
LEVELS = {"trace": logging.DEBUG, "warning": logging.WARNING, "error": logging.ERROR}
def log(level, message, exception):
logger.log(LEVELS.get(level, logging.INFO), message)
try:
with Parser("./protected.pdf", ParserSettings(log)) as parser:
parser.get_text()
except InvalidPasswordException:
logger.info("Skipped a protected document")
The following sample file is used in this example: protected.pdf
Expected behavior:
ERROR groupdocs.parser: Exception of type 'GroupDocs.Parser.Exceptions.InvalidPasswordException' was thrown.
INFO groupdocs.parser: Skipped a protected document
ParserSettingshas no empty constructor: pass a logger, an OCR connector or an external resource handler. To pass a logger together with a handler, pass all three in order, withNonefor the OCR connector:ParserSettings(log, None, on_loading).- The engine reports what it encounters; a document that opens and parses cleanly may produce no messages at all.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
