forked from github/pelican
ed3209888a
Old system was using manual string formatting for log messages. This caused issues with common operations like exception logging because often they need to be handled differently for Py2/Py3 compatibility. In order to unify the effort: - All logging is changed to `logging.level(msg, arg1, arg2)` style. - A `SafeLogger` is implemented to auto-decode exceptions properly in the args (ref #1403). - Custom formatters were overriding useful logging functionality like traceback outputing (ref #1402). They are refactored to be more transparent. Traceback information is provided in `--debug` mode for `read_file` errors in generators. - Formatters will now auto-format multiline log messages in order to make them look related. Similarly, traceback will be formatted in the same fashion. - `pelican.log.LimitFilter` was (ab)using logging message which would result in awkward syntax for argumented logging style. This functionality is moved to `extra` keyword argument. - Levels for errors that would result skipping a file (`read_file`) changed from `warning` to `error` in order to make them stand out among other logs. - Small consistency changes to log messages (i.e. changing all to start with an uppercase letter) and quality-of-life improvements (some log messages were dumping raw object information).
97 lines
2.7 KiB
Python
97 lines
2.7 KiB
Python
import os
|
|
import functools
|
|
import logging
|
|
|
|
import six
|
|
|
|
from pelican.utils import (slugify, python_2_unicode_compatible)
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@python_2_unicode_compatible
|
|
@functools.total_ordering
|
|
class URLWrapper(object):
|
|
def __init__(self, name, settings):
|
|
# next 2 lines are redundant with the setter of the name property
|
|
# but are here for clarity
|
|
self.settings = settings
|
|
self._name = name
|
|
self.slug = slugify(name, self.settings.get('SLUG_SUBSTITUTIONS', ()))
|
|
self.name = name
|
|
|
|
@property
|
|
def name(self):
|
|
return self._name
|
|
|
|
@name.setter
|
|
def name(self, name):
|
|
self._name = name
|
|
self.slug = slugify(name, self.settings.get('SLUG_SUBSTITUTIONS', ()))
|
|
|
|
def as_dict(self):
|
|
d = self.__dict__
|
|
d['name'] = self.name
|
|
return d
|
|
|
|
def __hash__(self):
|
|
return hash(self.slug)
|
|
|
|
def _key(self):
|
|
return self.slug
|
|
|
|
def _normalize_key(self, key):
|
|
subs = self.settings.get('SLUG_SUBSTITUTIONS', ())
|
|
return six.text_type(slugify(key, subs))
|
|
|
|
def __eq__(self, other):
|
|
return self._key() == self._normalize_key(other)
|
|
|
|
def __ne__(self, other):
|
|
return self._key() != self._normalize_key(other)
|
|
|
|
def __lt__(self, other):
|
|
return self._key() < self._normalize_key(other)
|
|
|
|
def __str__(self):
|
|
return self.name
|
|
|
|
def __repr__(self):
|
|
return '<{} {}>'.format(type(self).__name__, str(self))
|
|
|
|
def _from_settings(self, key, get_page_name=False):
|
|
"""Returns URL information as defined in settings.
|
|
|
|
When get_page_name=True returns URL without anything after {slug} e.g.
|
|
if in settings: CATEGORY_URL="cat/{slug}.html" this returns
|
|
"cat/{slug}" Useful for pagination.
|
|
|
|
"""
|
|
setting = "%s_%s" % (self.__class__.__name__.upper(), key)
|
|
value = self.settings[setting]
|
|
if not isinstance(value, six.string_types):
|
|
logger.warning('%s is set to %s', (setting, value))
|
|
return value
|
|
else:
|
|
if get_page_name:
|
|
return os.path.splitext(value)[0].format(**self.as_dict())
|
|
else:
|
|
return value.format(**self.as_dict())
|
|
|
|
page_name = property(functools.partial(_from_settings, key='URL',
|
|
get_page_name=True))
|
|
url = property(functools.partial(_from_settings, key='URL'))
|
|
save_as = property(functools.partial(_from_settings, key='SAVE_AS'))
|
|
|
|
|
|
class Category(URLWrapper):
|
|
pass
|
|
|
|
|
|
class Tag(URLWrapper):
|
|
def __init__(self, name, *args, **kwargs):
|
|
super(Tag, self).__init__(name.strip(), *args, **kwargs)
|
|
|
|
|
|
class Author(URLWrapper):
|
|
pass
|