def compile(conf, env, force=False, **options):
"""The compilation process.
Current API:
#. when we require context
#. when we called an event
New API:
#. before we start with view Initialization
#. after we initialized views
#. before we require context
#. after we required context
#. before we template
#. before we write a file
#. when we called an event
#. when we finish
"""
# time measurement
ctime = time.time()
# populate env and corrects some conf things
request = initialize(conf, env)
# load pages/entries and store them in env
entrylist, pages = readers.load(conf)
env.globals['entrylist'] = entrylist
env.globals['pages'] = pages
# XXX translations should be moved out of core
env.globals['translations'] = translations = []
if force:
# acrylamid compile -f
cache.clear()
# here we store all found filter and their aliases
ns = defaultdict(set)
# get available filter list, something like with obj.get-function
# list = [<class head_offset.Headoffset at 0x1014882c0>, <class html.HTML at 0x101488328>,...]
aflist = filters.get_filters()
# ... and get all configured views
_views = views.get_views()
# filters found in all entries, views and conf.py
found = sum((x.filters for x in entrylist+pages+_views), []) + request['conf']['filters']
for val in found:
# first we for `no` and get the function name and arguments
f = val[2:] if val.startswith('no') else val
fname, fargs = f.split('+')[:1][0], f.split('+')[1:]
try:
# initialize the filter with its function name and arguments
fx = aflist[fname](conf, env, val, *fargs)
if val.startswith('no'):
fx = filters.disable(fx)
except ValueError:
try:
fx = aflist[val.split('+')[:1][0]](conf, env, val, *fargs)
except ValueError:
raise AcrylamidException('no such filter: %s' % val)
ns[fx].add(val)
for entry in entrylist + pages:
for v in _views:
# a list that sorts out conflicting and duplicated filters
flst = filters.FilterList()
# filters found in this specific entry plus views and conf.py
found = entry.filters + v.filters + request['conf']['filters']
for fn in found:
fx, _ = next((k for k in ns.iteritems() if fn in k[1]))
if fx not in flst:
flst.append(fx)
# sort them ascending because we will pop within filters.add
entry.filters.add(sorted(flst, key=lambda k: (-k.priority, k.name)),
context=v.__class__.__name__)
# lets offer a last break to populate tags or so
# XXX this API component needs a review
for v in _views:
env = v.context(env, {'entrylist': entrylist, 'pages': pages,
'translations': translations})
# now teh real thing!
for v in _views:
# XXX the entry should automatically determine its caller (using
# some sys magic to recursively check wether the calling class is
# derieved from `View`.)
for entry in entrylist + pages + translations:
entry.context = v.__class__.__name__
request['pages'], request['translations'] = pages, translations
request['entrylist'] = filter(v.condition, entrylist)
tt = time.time()
for html, path in v.generate(request):
helpers.mkfile(html, path, time.time()-tt, **options)
tt = time.time()
# remove abandoned cache files
cache.shutdown()
# print a short summary
log.info('%i new, %i updated, %i skipped [%.2fs]', event.count('create'),
event.count('update'), event.count('identical') + event.count('skip'),
time.time() - ctime)
def initialize(conf, env):
"""Initializes Jinja2 environment, prepares locale and configure
some minor things. Filter and View are inited with conf and env,
a request dict is returned.
"""
# initialize cache, optional to cache_dir
cache.init(conf.get('cache_dir', None))
# set up templating environment
env.engine = utils.import_object(conf['engine'])()
env.engine.init(conf['layout_dir'], cache.cache_dir)
env.engine.register('safeslug', helpers.safeslug)
env.engine.register('tagify', lambda x: x)
# try language set in LANG, if set correctly use it
try:
locale.setlocale(locale.LC_ALL, conf.get('lang', ''))
except (locale.Error, TypeError):
# try if LANG is an alias
try:
locale.setlocale(locale.LC_ALL, locale.locale_alias[conf['lang'].lower()])
except (locale.Error, KeyError):
# LANG is not an alias, so we use system's default
locale.setlocale(locale.LC_ALL, '')
log.info('notice your OS does not support %s, fallback to %s', conf['lang'],
locale.getlocale()[0])
if locale.getlocale()[0] is not None:
conf['lang'] = locale.getlocale()[0][:2]
else:
# getlocale() is (None, None) aka 'C'
conf['lang'] = 'en'
if 'www_root' not in conf:
log.warn('no `www_root` specified, using localhost:8000')
conf['www_root'] = 'http://localhost:8000/'
env['protocol'], env['netloc'], env['path'], x, y = urlsplit(conf['www_root'])
# take off the trailing slash for www_root and path
conf['www_root'] = conf['www_root'].rstrip('/')
env['path'] = env['path'].rstrip('/')
# check if encoding is available
try:
codecs.lookup(conf['encoding'])
except LookupError:
raise AcrylamidException('no such encoding available: %r' % conf['encoding'])
# prepare, import and initialize filters and views
if isinstance(conf['filters_dir'], basestring):
conf['filters_dir'] = [conf['filters_dir'], ]
if isinstance(conf['views_dir'], basestring):
conf['views_dir'] = [conf['views_dir'], ]
lazy.enable()
filters.initialize(conf["filters_dir"], conf, env, exclude=conf["filters_ignore"],
include=conf["filters_include"])
lazy.disable() # this has weird side effects with jinja2, so disabled after filters
views.initialize(conf["views_dir"], conf, env)
env['views'] = dict([(v.view, v) for v in views.get_views()])
entryfmt, pagefmt = '/:year/:slug/', '/:slug/'
for view in views.get_views():
if view.view == 'entry':
entryfmt = view.path
if view.view == 'page':
pagefmt = view.path
conf['entry_permalink'] = conf['entry_permalink'] or entryfmt
conf['page_permalink'] = conf['page_permalink'] or pagefmt
return {'conf': conf, 'env': env}
def compile(conf, env):
"""The compilation process."""
if env.options.force:
cache.clear(conf.get("cache_dir"))
# time measurement
ctime = time.time()
# populate env and corrects some conf things
data = initialize(conf, env)
# load pages/entries and store them in env
rv = dict(zip(["entrylist", "pages", "translations", "drafts"], map(HashableList, readers.load(conf))))
entrylist, pages = rv["entrylist"], rv["pages"]
translations, drafts = rv["translations"], rv["drafts"]
# load references
refs.load(entrylist, pages, translations, drafts)
data.update(rv)
env.globals.update(rv)
# here we store all found filter and their aliases
ns = defaultdict(set)
# [<class head_offset.Headoffset at 0x1014882c0>, <class html.HTML at 0x101488328>,...]
aflist = filters.get_filters()
# ... and get all configured views
_views = views.get_views()
# filters found in all entries, views and conf.py (skip translations, has no items)
found = sum((x.filters for x in chain(entrylist, pages, drafts, _views, [conf])), [])
for val in found:
# first we for `no` and get the function name and arguments
f = val[2:] if val.startswith("no") else val
fname, fargs = f.split("+")[:1][0], f.split("+")[1:]
try:
# initialize the filter with its function name and arguments
fx = aflist[fname](conf, env, val, *fargs)
if val.startswith("no"):
fx = filters.disable(fx)
except ValueError:
try:
fx = aflist[val.split("+")[:1][0]](conf, env, val, *fargs)
except ValueError:
raise AcrylamidException("no such filter: %s" % val)
ns[fx].add(val)
# include actual used filters to trigger modified state
env.filters = HashableList(ns.keys())
for entry in chain(entrylist, pages, drafts):
for v in _views:
# a list that sorts out conflicting and duplicated filters
flst = filters.FilterList()
# filters found in this specific entry plus views and conf.py
found = entry.filters + v.filters + data["conf"]["filters"]
for fn in found:
fx, _ = next((k for k in ns.iteritems() if fn in k[1]))
if fx not in flst:
flst.append(fx)
# sort them ascending because we will pop within filters.add
entry.filters.add(sorted(flst, key=lambda k: (-k.priority, k.name)), context=v)
# lets offer a last break to populate tags and such
for v in _views:
env = v.context(conf, env, data)
# now teh real thing!
for v in _views:
for entry in chain(entrylist, pages, translations, drafts):
entry.context = v
for var in "entrylist", "pages", "translations", "drafts":
data[var] = HashableList(filter(v.condition, locals()[var])) if v.condition else locals()[var]
tt = time.time()
for buf, path in v.generate(conf, env, data):
try:
helpers.mkfile(
buf, path, time.time() - tt, ns=v.name, force=env.options.force, dryrun=env.options.dryrun
)
except UnicodeError:
log.exception(path)
finally:
buf.close()
tt = time.time()
# copy modified/missing assets to output
assets.compile(conf, env)
# wait for unfinished hooks
hooks.shutdown()
# save conf/environment hash and new/changed/unchanged references
helpers.memoize("Configuration", hash(conf))
helpers.memoize("Environment", hash(env))
refs.save()
# remove abandoned cache files
cache.shutdown()
# print a short summary
log.info(
"%i new, %i updated, %i skipped [%.2fs]",
event.count("create"),
event.count("update"),
event.count("identical") + event.count("skip"),
time.time() - ctime,
)
def initialize(conf, env):
"""Initializes Jinja2 environment, prepares locale and configure
some minor things. Filter and View are inited with conf and env,
a data dict is returned.
"""
# initialize cache, optional to cache_dir
cache.init(conf.get("cache_dir"))
env["version"] = type("Version", (str,), dict(zip(["major", "minor"], LooseVersion(dist.version).version[:2])))(
dist.version
)
# crawl through CHANGES.md and stop on breaking changes
if history.breaks(env, cache.emptyrun):
cache.shutdown()
print "Detected version upgrade that might break your configuration. Run"
print "Acrylamid a second time to get rid of this message and premature exit."
raise SystemExit
# register hooks
if env.options.parser.startswith(("co", "gen", "auto", "aco")):
hooks.initialize(conf, env)
# set up templating environment
env.engine = import_object(conf["engine"])()
env.engine.init(conf["theme"], cache.cache_dir)
env.engine.register("safeslug", helpers.safeslug)
env.engine.register("tagify", lambda x: x)
# try language set in LANG, if set correctly use it
try:
locale.setlocale(locale.LC_ALL, str(conf.get("lang", "")))
except (locale.Error, TypeError):
# try if LANG is an alias
try:
locale.setlocale(locale.LC_ALL, locale.locale_alias[str(conf.get("lang", "")).lower()])
except (locale.Error, KeyError):
# LANG is not an alias, so we use system's default
try:
locale.setlocale(locale.LC_ALL, "")
except locale.Error:
pass # hope this makes Travis happy
log.info("notice your OS does not support %s, fallback to %s", conf.get("lang", ""), locale.getlocale()[0])
if locale.getlocale()[0] is not None:
conf["lang"] = locale.getlocale()[0][:2]
else:
# getlocale() is (None, None) aka 'C'
conf["lang"] = "en"
if "www_root" not in conf:
log.warn("no `www_root` specified, using localhost:8000")
conf["www_root"] = "http://localhost:8000/"
# figure out timezone and set offset, more verbose for 2.6 compatibility
td = datetime.now() - datetime.utcnow()
offset = round(total_seconds(td) / 3600.0)
conf["tzinfo"] = readers.Timezone(offset)
# determine http(s), host and path
env["protocol"], env["netloc"], env["path"], x, y = urlsplit(conf["www_root"])
# take off the trailing slash for www_root and path
conf["www_root"] = conf["www_root"].rstrip("/")
env["path"] = env["path"].rstrip("/")
if env["path"]:
conf["output_dir"] = conf["output_dir"] + env["path"]
lazy.enable()
filters.initialize(conf["filters_dir"][:], conf, env)
lazy.disable() # this has weird side effects with jinja2, so disabled after filters
views.initialize(conf["views_dir"][:], conf, env)
env.views = views.Views(view for view in views.get_views())
entryfmt, pagefmt = "/:year/:slug/", "/:slug/"
for view in views.get_views():
if view.name == "entry":
entryfmt = view.path
if view.name == "page":
pagefmt = view.path
conf.setdefault("entry_permalink", entryfmt)
conf.setdefault("page_permalink", pagefmt)
return {"conf": conf, "env": env}
def initialize(conf, env):
"""Initializes Jinja2 environment, prepares locale and configure
some minor things. Filter and View are inited with conf and env,
a request dict is returned.
"""
# initialize cache, optional to cache_dir
cache.init(conf.get('cache_dir', None))
# set up templating environment
env.engine = utils.import_object(conf['engine'])()
env.engine.init(conf['layout_dir'], cache.cache_dir)
env.engine.register('safeslug', helpers.safeslug)
env.engine.register('tagify', lambda x: x)
# try language set in LANG, if set correctly use it
try:
locale.setlocale(locale.LC_ALL, str(conf.get('lang', '')))
except (locale.Error, TypeError):
# try if LANG is an alias
try:
locale.setlocale(
locale.LC_ALL, locale.locale_alias[str(conf.get('lang',
'')).lower()])
except (locale.Error, KeyError):
# LANG is not an alias, so we use system's default
try:
locale.setlocale(locale.LC_ALL, '')
except locale.Error:
pass # hope this makes Travis happy
log.info('notice your OS does not support %s, fallback to %s',
conf.get('lang', ''),
locale.getlocale()[0])
if locale.getlocale()[0] is not None:
conf['lang'] = locale.getlocale()[0][:2]
else:
# getlocale() is (None, None) aka 'C'
conf['lang'] = 'en'
if 'www_root' not in conf:
log.warn('no `www_root` specified, using localhost:8000')
conf['www_root'] = 'http://localhost:8000/'
# figure out timezone and set offset, more verbose for 2.6 compatibility
td = (datetime.now() - datetime.utcnow())
total_seconds = (td.microseconds +
(td.seconds + td.days * 24 * 3600) * 10**6) / 10**6
offset = round(total_seconds / 3600.0)
conf['tzinfo'] = readers.Timezone(offset)
# determine http(s), host and path
env['protocol'], env['netloc'], env['path'], x, y = urlsplit(
conf['www_root'])
# take off the trailing slash for www_root and path
conf['www_root'] = conf['www_root'].rstrip('/')
env['path'] = env['path'].rstrip('/')
# check if encoding is available
try:
codecs.lookup(conf['encoding'])
except LookupError:
raise AcrylamidException('no such encoding available: %r' %
conf['encoding'])
# prepare, import and initialize filters and views
if isinstance(conf['filters_dir'], basestring):
conf['filters_dir'] = [
conf['filters_dir'],
]
if isinstance(conf['views_dir'], basestring):
conf['views_dir'] = [
conf['views_dir'],
]
lazy.enable()
filters.initialize(conf["filters_dir"],
conf,
env,
exclude=conf["filters_ignore"],
include=conf["filters_include"])
lazy.disable(
) # this has weird side effects with jinja2, so disabled after filters
views.initialize(conf["views_dir"], conf, env)
env['views'] = dict([(v.view, v) for v in views.get_views()])
entryfmt, pagefmt = '/:year/:slug/', '/:slug/'
for view in views.get_views():
if view.view == 'entry':
entryfmt = view.path
if view.view == 'page':
pagefmt = view.path
conf.setdefault('entry_permalink', entryfmt)
conf.setdefault('page_permalink', pagefmt)
return {'conf': conf, 'env': env}
def initialize(conf, env):
"""Initializes Jinja2 environment, prepares locale and configure
some minor things. Filter and View are inited with conf and env,
a data dict is returned.
"""
# initialize cache, optional to cache_dir
cache.init(conf.get('cache_dir'))
env['version'] = type('Version', (str, ), dict(zip(
['major', 'minor'], LooseVersion(dist.version).version[:2])))(dist.version)
# crawl through CHANGES.md and stop on breaking changes
if history.breaks(env, cache.emptyrun):
cache.shutdown()
print("Detected version upgrade that might break your configuration. Run")
print("Acrylamid a second time to get rid of this message and premature exit.")
raise SystemExit
# set up templating environment
env.engine = import_object(conf['engine'])()
env.engine.init(conf['theme'], cache.cache_dir)
env.engine.register('safeslug', helpers.safeslug)
env.engine.register('tagify', lambda x: x)
# try language set in LANG, if set correctly use it
try:
locale.setlocale(locale.LC_ALL, str(conf.get('lang', '')))
except (locale.Error, TypeError):
# try if LANG is an alias
try:
locale.setlocale(locale.LC_ALL, locale.locale_alias[str(conf.get('lang', '')).lower()])
except (locale.Error, KeyError):
# LANG is not an alias, so we use system's default
try:
locale.setlocale(locale.LC_ALL, '')
except locale.Error:
pass # hope this makes Travis happy
log.info('notice your OS does not support %s, fallback to %s', conf.get('lang', ''),
locale.getlocale()[0])
if locale.getlocale()[0] is not None:
conf['lang'] = locale.getlocale()[0][:2]
else:
# getlocale() is (None, None) aka 'C'
conf['lang'] = 'en'
if 'www_root' not in conf:
log.warn('no `www_root` specified, using localhost:8000')
conf['www_root'] = 'http://localhost:8000/'
# figure out timezone and set offset, more verbose for 2.6 compatibility
td = (datetime.now() - datetime.utcnow())
offset = round(total_seconds(td) / 3600.0)
conf['tzinfo'] = readers.Timezone(offset)
# determine http(s), host and path
env['protocol'], env['netloc'], env['path'], x, y = urlsplit(conf['www_root'])
# take off the trailing slash for www_root and path
conf['www_root'] = conf['www_root'].rstrip('/')
env['path'] = env['path'].rstrip('/')
if env['path']:
conf['output_dir'] = conf['output_dir'] + env['path']
lazy.enable()
filters.initialize(conf["filters_dir"][:], conf, env)
lazy.disable() # this has weird side effects with jinja2, so disabled after filters
views.initialize(conf["views_dir"][:], conf, env)
env.views = views.Views(view for view in views.get_views())
entryfmt, pagefmt = '/:year/:slug/', '/:slug/'
for view in views.get_views():
if view.name == 'entry':
entryfmt = view.path
if view.name == 'page':
pagefmt = view.path
conf.setdefault('entry_permalink', entryfmt)
conf.setdefault('page_permalink', pagefmt)
# register webassets to theme engine, make webassets available as env.webassets
assets.initialize(conf, env)
return {'conf': conf, 'env': env}
def initialize(conf, env):
"""Initializes Jinja2 environment, prepares locale and configure
some minor things. Filter and View are inited with conf and env,
a request dict is returned.
"""
# initialize cache, optional to cache_dir
cache.init(conf.get('cache_dir', None))
# rewrite static directory
assets.initialize(conf, env)
# set up templating environment
env.engine = utils.import_object(conf['engine'])()
env.engine.init(conf['theme'], cache.cache_dir)
env.engine.register('safeslug', helpers.safeslug)
env.engine.register('tagify', lambda x: x)
# try language set in LANG, if set correctly use it
try:
locale.setlocale(locale.LC_ALL, str(conf.get('lang', '')))
except (locale.Error, TypeError):
# try if LANG is an alias
try:
locale.setlocale(locale.LC_ALL, locale.locale_alias[str(conf.get('lang', '')).lower()])
except (locale.Error, KeyError):
# LANG is not an alias, so we use system's default
try:
locale.setlocale(locale.LC_ALL, '')
except locale.Error:
pass # hope this makes Travis happy
log.info('notice your OS does not support %s, fallback to %s', conf.get('lang', ''),
locale.getlocale()[0])
if locale.getlocale()[0] is not None:
conf['lang'] = locale.getlocale()[0][:2]
else:
# getlocale() is (None, None) aka 'C'
conf['lang'] = 'en'
if 'www_root' not in conf:
log.warn('no `www_root` specified, using localhost:8000')
conf['www_root'] = 'http://localhost:8000/'
# figure out timezone and set offset, more verbose for 2.6 compatibility
td = (datetime.now() - datetime.utcnow())
total_seconds = (td.microseconds + (td.seconds + td.days * 24 * 3600) * 10**6) / 10**6
offset = round(total_seconds / 3600.0)
conf['tzinfo'] = readers.Timezone(offset)
# determine http(s), host and path
env['protocol'], env['netloc'], env['path'], x, y = urlsplit(conf['www_root'])
# take off the trailing slash for www_root and path
conf['www_root'] = conf['www_root'].rstrip('/')
env['path'] = env['path'].rstrip('/')
# check if encoding is available
try:
codecs.lookup(conf['encoding'])
except LookupError:
raise AcrylamidException('no such encoding available: %r' % conf['encoding'])
# prepare, import and initialize filters and views
if isinstance(conf['filters_dir'], basestring):
conf['filters_dir'] = [conf['filters_dir'], ]
if isinstance(conf['views_dir'], basestring):
conf['views_dir'] = [conf['views_dir'], ]
lazy.enable()
filters.initialize(conf["filters_dir"], conf, env)
lazy.disable() # this has weird side effects with jinja2, so disabled after filters
views.initialize(conf["views_dir"], conf, env)
env.views = views.Views(view for view in views.get_views())
entryfmt, pagefmt = '/:year/:slug/', '/:slug/'
for view in views.get_views():
if view.name == 'entry':
entryfmt = view.path
if view.name == 'page':
pagefmt = view.path
conf.setdefault('entry_permalink', entryfmt)
conf.setdefault('page_permalink', pagefmt)
return {'conf': conf, 'env': env}
def compile(conf, env, force=False, **options):
"""The compilation process.
Current API:
#. when we require context
#. when we called an event
New API:
#. before we start with view Initialization
#. after we initialized views
#. before we require context
#. after we required context
#. before we template
#. before we write a file
#. when we called an event
#. when we finish
"""
# time measurement
ctime = time.time()
# populate env and corrects some conf things
request = initialize(conf, env)
# load pages/entries and store them in env
entrylist, pages = readers.load(conf)
env.globals['entrylist'] = entrylist
env.globals['pages'] = pages
# XXX translations should be moved out of core
env.globals['translations'] = translations = []
if force:
# acrylamid compile -f
cache.clear()
# here we store all found filter and their aliases
ns = defaultdict(set)
# get available filter list, something like with obj.get-function
# list = [<class head_offset.Headoffset at 0x1014882c0>, <class html.HTML at 0x101488328>,...]
aflist = filters.get_filters()
# ... and get all configured views
_views = views.get_views()
# filters found in all entries, views and conf.py
found = sum(
(x.filters
for x in entrylist + pages + _views), []) + request['conf']['filters']
for val in found:
# first we for `no` and get the function name and arguments
f = val[2:] if val.startswith('no') else val
fname, fargs = f.split('+')[:1][0], f.split('+')[1:]
try:
# initialize the filter with its function name and arguments
fx = aflist[fname](conf, env, val, *fargs)
if val.startswith('no'):
fx = filters.disable(fx)
except ValueError:
try:
fx = aflist[val.split('+')[:1][0]](conf, env, val, *fargs)
except ValueError:
raise AcrylamidException('no such filter: %s' % val)
ns[fx].add(val)
for entry in entrylist + pages:
for v in _views:
# a list that sorts out conflicting and duplicated filters
flst = filters.FilterList()
# filters found in this specific entry plus views and conf.py
found = entry.filters + v.filters + request['conf']['filters']
for fn in found:
fx, _ = next((k for k in ns.iteritems() if fn in k[1]))
if fx not in flst:
flst.append(fx)
# sort them ascending because we will pop within filters.add
entry.filters.add(sorted(flst, key=lambda k:
(-k.priority, k.name)),
context=v)
# lets offer a last break to populate tags or so
# XXX this API component needs a review
for v in _views:
env = v.context(env, {
'entrylist': entrylist,
'pages': pages,
'translations': translations
})
# now teh real thing!
for v in _views:
# XXX the entry should automatically determine its caller (using
# some sys magic to recursively check wether the calling class is
# derieved from `View`.)
for entry in entrylist + pages + translations:
entry.context = v
request['pages'], request['translations'] = pages, translations
request['entrylist'] = filter(v.condition, entrylist)
tt = time.time()
for html, path in v.generate(request):
helpers.mkfile(html, path, time.time() - tt, **options)
tt = time.time()
# remove abandoned cache files
cache.shutdown()
# print a short summary
log.info('%i new, %i updated, %i skipped [%.2fs]', event.count('create'),
event.count('update'),
event.count('identical') + event.count('skip'),
time.time() - ctime)
def compile(conf, env):
"""The compilation process."""
if env.options.force:
cache.clear(conf.get('cache_dir'))
# time measurement
ctime = time.time()
# populate env and corrects some conf things
data = initialize(conf, env)
# load pages/entries and store them in env
rv = dict(zip(['entrylist', 'pages', 'translations', 'drafts'],
map(HashableList, readers.load(conf))))
entrylist, pages = rv['entrylist'], rv['pages']
translations, drafts = rv['translations'], rv['drafts']
# load references
refs.load(entrylist, pages, translations, drafts)
data.update(rv)
env.globals.update(rv)
# here we store all found filter and their aliases
ns = defaultdict(set)
# get available filter list, something like with obj.get-function
# list = [<class head_offset.Headoffset at 0x1014882c0>, <class html.HTML at 0x101488328>,...]
aflist = filters.get_filters()
# ... and get all configured views
_views = views.get_views()
# filters found in all entries, views and conf.py (skip translations, has no items)
found = sum((x.filters for x in chain(entrylist, pages, drafts, _views, [conf])), [])
for val in found:
# first we for `no` and get the function name and arguments
f = val[2:] if val.startswith('no') else val
fname, fargs = f.split('+')[:1][0], f.split('+')[1:]
try:
# initialize the filter with its function name and arguments
fx = aflist[fname](conf, env, val, *fargs)
if val.startswith('no'):
fx = filters.disable(fx)
except ValueError:
try:
fx = aflist[val.split('+')[:1][0]](conf, env, val, *fargs)
except ValueError:
raise AcrylamidException('no such filter: %s' % val)
ns[fx].add(val)
for entry in chain(entrylist, pages, drafts):
for v in _views:
# a list that sorts out conflicting and duplicated filters
flst = filters.FilterList()
# filters found in this specific entry plus views and conf.py
found = entry.filters + v.filters + data['conf']['filters']
for fn in found:
fx, _ = next((k for k in ns.iteritems() if fn in k[1]))
if fx not in flst:
flst.append(fx)
# sort them ascending because we will pop within filters.add
entry.filters.add(sorted(flst, key=lambda k: (-k.priority, k.name)),
context=v)
# lets offer a last break to populate tags and such
for v in _views:
env = v.context(conf, env, data)
# now teh real thing!
for v in _views:
for entry in chain(entrylist, pages, translations, drafts):
entry.context = v
for var in 'entrylist', 'pages', 'translations', 'drafts':
data[var] = HashableList(filter(v.condition, locals()[var])) \
if v.condition else locals()[var]
tt = time.time()
for buf, path in v.generate(conf, env, data):
try:
helpers.mkfile(buf, path, time.time()-tt, **env.options.__dict__)
finally:
buf.close()
tt = time.time()
# copy modified/missing assets to output
assets.compile(conf, env)
# save conf/environment hash and new/changed/unchanged references
helpers.memoize('Configuration', hash(conf))
helpers.memoize('Environment', hash(env))
refs.save()
# remove abandoned cache files
cache.shutdown()
# print a short summary
log.info('%i new, %i updated, %i skipped [%.2fs]', event.count('create'),
event.count('update'), event.count('identical') + event.count('skip'),
time.time() - ctime)
def compile(conf, env, force=False, **options):
# time measurement
ctime = time.time()
# populate env and corrects some conf things
request = initialize(conf, env)
if force:
# acrylamid compile -f
cache.clear()
# list of FileEntry-objects reverse sorted by date.
entrylist = sorted([FileEntry(e, conf) for e in utils.filelist(conf['content_dir'],
conf.get('entries_ignore', []))],
key=lambda k: k.date, reverse=True)
# here we store all possible filter configurations
ns = set()
# get available filter list, something like with obj.get-function
# list = [<class head_offset.Headoffset at 0x1014882c0>, <class html.HTML at 0x101488328>,...]
aflist = filters.get_filters()
# ... and get all configured views
_views = views.get_views()
# filters found in all entries, views and conf.py
found = sum((x.filters for x in entrylist+_views), []) + request['conf']['filters']
for val in found:
# first we for `no` and get the function name and arguments
f = val[2:] if val.startswith('no') else val
fname, fargs = f.split('+')[:1][0], f.split('+')[1:]
try:
# initialize the filter with its function name and arguments
fx = aflist[fname](val, *fargs)
if val.startswith('no'):
fx.transform = lambda x, y, *z: x
fx.__hash__ = lambda : 0
except ValueError:
try:
fx = aflist[val.split('+')[:1][0]](val, *fargs)
except ValueError:
raise AcrylamidException('no such filter: %s' % val)
ns.add(fx)
for entry in entrylist:
for v in _views:
# a list that sorts out conflicting and duplicated filters
flst = filters.FilterList()
# filters found in this specific entry plus views and conf.py
found = entry.filters + v.filters + request['conf']['filters']
for fn in found:
fx = filter(lambda k: fn == k.name, ns)[0]
if fx not in flst:
flst.append(fx)
# sort them ascending because we will pop within filters.add
entry.filters.add(sorted(flst, key=lambda k: (-k.priority, k.name)),
context=v.__class__.__name__)
# lets offer a last break to populate tags or so
# XXX this API component needs a review
for v in _views:
env = v.context(env, {'entrylist': filter(v.condition, entrylist)})
# now teh real thing!
for v in _views:
# XXX the entry should automatically determine its caller (using
# some sys magic to recursively check wether the calling class is
# derieved from `View`.)
for entry in entrylist:
entry.context = v.__class__.__name__
request['entrylist'] = filter(v.condition, entrylist)
tt = time.time()
for html, path in v.generate(request):
helpers.mkfile(html, path, time.time()-tt, **options)
tt = time.time()
# remove abandoned cache files
cache.shutdown()
log.info('Blog compiled in %.2fs' % (time.time() - ctime))
def initialize(conf, env):
"""Initializes Jinja2 environment, prepares locale and configure
some minor things. Filter and View are inited with conf and env,
a request dict is returned.
"""
# initialize cache, optional to cache_dir
cache.init(conf.get('cache_dir', None))
# set up templating environment
env['jinja2'] = Environment(loader=ExtendedFileSystemLoader(conf['layout_dir']),
bytecode_cache=FileSystemBytecodeCache(cache.cache_dir))
env['jinja2'].filters.update({'safeslug': helpers.safeslug, 'tagify': lambda x: x})
# try language set in LANG, if set correctly use it
try:
locale.setlocale(locale.LC_ALL, conf.get('lang', ''))
except (locale.Error, TypeError):
# try if LANG is an alias
try:
locale.setlocale(locale.LC_ALL, locale.locale_alias[conf['lang'].lower()])
except (locale.Error, KeyError):
# LANG is not an alias, so we use system's default
locale.setlocale(locale.LC_ALL, '')
log.info('notice your OS does not support %s, fallback to %s', conf['lang'],
locale.getlocale()[0])
if locale.getlocale()[0] is not None:
conf['lang'] = locale.getlocale()[0][:2]
else:
# getlocale() is (None, None) aka 'C'
conf['lang'] = 'en'
if 'www_root' not in conf:
log.warn('no `www_root` specified, using localhost:8000')
conf['www_root'] = 'http://localhost:8000/'
env['protocol'], env['netloc'], env['path'], x, y = urlsplit(conf['www_root'])
# take off the trailing slash for www_root and path
conf['www_root'] = conf['www_root'].rstrip('/')
env['path'] = env['path'].rstrip('/')
# check if encoding is available
try:
codecs.lookup(conf['encoding'])
except LookupError:
raise AcrylamidException('no such encoding available: %r' % conf['encoding'])
# prepare, import and initialize filters and views
if isinstance(conf['filters_dir'], basestring):
conf['filters_dir'] = [conf['filters_dir'], ]
if isinstance(conf['views_dir'], basestring):
conf['views_dir'] = [conf['views_dir'], ]
filters.initialize(conf["filters_dir"], conf, env, exclude=conf["filters_ignore"],
include=conf["filters_include"])
views.initialize(conf["views_dir"], conf, env)
env['views'] = dict([(v.view, v) for v in views.get_views()])
return {'conf': conf, 'env': env}
def initialize(conf, env):
"""Initializes Jinja2 environment, prepares locale and configure
some minor things. Filter and View are inited with conf and env,
a data dict is returned.
"""
# initialize cache, optional to cache_dir
cache.init(conf.get('cache_dir'))
env['version'] = type(
'Version', (str, ),
dict(zip(['major', 'minor'],
LooseVersion(dist.version).version[:2])))(dist.version)
# crawl through CHANGES.md and stop on breaking changes
if history.breaks(env, cache.emptyrun):
cache.shutdown()
print(
"Detected version upgrade that might break your configuration. Run"
)
print(
"Acrylamid a second time to get rid of this message and premature exit."
)
raise SystemExit
# set up templating environment
env.engine = import_object(conf['engine'])(conf['theme'], cache.cache_dir)
env.engine.register('safeslug', helpers.safeslug)
env.engine.register('tagify', lambda x: x)
# try language set in LANG, if set correctly use it
try:
locale.setlocale(locale.LC_ALL, str(conf.get('lang', '')))
except (locale.Error, TypeError):
# try if LANG is an alias
try:
locale.setlocale(
locale.LC_ALL, locale.locale_alias[str(conf.get('lang',
'')).lower()])
except (locale.Error, KeyError):
# LANG is not an alias, so we use system's default
try:
locale.setlocale(locale.LC_ALL, '')
except locale.Error:
pass # hope this makes Travis happy
log.info('notice your OS does not support %s, fallback to %s',
conf.get('lang', ''),
locale.getlocale()[0])
if locale.getlocale()[0] is not None:
conf['lang'] = locale.getlocale()[0][:2]
else:
# getlocale() is (None, None) aka 'C'
conf['lang'] = 'en'
if 'www_root' not in conf:
log.warn('no `www_root` specified, using localhost:8000')
conf['www_root'] = 'http://localhost:8000/'
# figure out timezone and set offset, more verbose for 2.6 compatibility
td = (datetime.now() - datetime.utcnow())
offset = round(total_seconds(td) / 3600.0)
conf['tzinfo'] = readers.Timezone(offset)
# determine http(s), host and path
env['protocol'], env['netloc'], env['path'], x, y = urlsplit(
conf['www_root'])
# take off the trailing slash for www_root and path
conf['www_root'] = conf['www_root'].rstrip('/')
env['path'] = env['path'].rstrip('/')
if env['path']:
conf['output_dir'] = conf['output_dir'] + env['path']
lazy.enable()
filters.initialize(conf["filters_dir"][:], conf, env)
lazy.disable(
) # this has weird side effects with jinja2, so disabled after filters
views.initialize(conf["views_dir"][:], conf, env)
env.views = views.Views(view for view in views.get_views())
entryfmt, pagefmt = '/:year/:slug/', '/:slug/'
for view in views.get_views():
if view.name == 'entry':
entryfmt = view.path
if view.name == 'page':
pagefmt = view.path
conf.setdefault('entry_permalink', entryfmt)
conf.setdefault('page_permalink', pagefmt)
# register webassets to theme engine, make webassets available as env.webassets
assets.initialize(conf, env)
return {'conf': conf, 'env': env}
def compile(conf, env):
"""The compilation process."""
hooks.initialize(conf, env)
hooks.run(conf, env, 'pre')
if env.options.force:
cache.clear(conf.get('cache_dir'))
# time measurement
ctime = time.time()
# populate env and corrects some conf things
data = initialize(conf, env)
# load pages/entries and store them in env
rv = dict(
zip(['entrylist', 'pages', 'translations', 'drafts'],
map(HashableList, readers.load(conf))))
entrylist, pages = rv['entrylist'], rv['pages']
translations, drafts = rv['translations'], rv['drafts']
# load references
refs.load(entrylist, pages, translations, drafts)
data.update(rv)
env.globals.update(rv)
# here we store all found filter and their aliases
ns = defaultdict(set)
# [<class head_offset.Headoffset at 0x1014882c0>, <class html.HTML at 0x101488328>,...]
aflist = filters.get_filters()
# ... and get all configured views
_views = views.get_views()
# filters found in all entries, views and conf.py (skip translations, has no items)
found = sum((x.filters
for x in chain(entrylist, pages, drafts, _views, [conf])), [])
for val in found:
# first we for `no` and get the function name and arguments
f = val[2:] if val.startswith('no') else val
fname, fargs = f.split('+')[:1][0], f.split('+')[1:]
try:
# initialize the filter with its function name and arguments
fx = aflist[fname](conf, env, val, *fargs)
if val.startswith('no'):
fx = filters.disable(fx)
except ValueError:
try:
fx = aflist[val.split('+')[:1][0]](conf, env, val, *fargs)
except ValueError:
raise AcrylamidException('no such filter: %s' % val)
ns[fx].add(val)
# include actual used filters to trigger modified state
env.filters = HashableList(iterkeys(ns))
for entry in chain(entrylist, pages, drafts):
for v in _views:
# a list that sorts out conflicting and duplicated filters
flst = filters.FilterList()
# filters found in this specific entry plus views and conf.py
found = entry.filters + v.filters + data['conf']['filters']
for fn in found:
fx, _ = next((k for k in iteritems(ns) if fn in k[1]))
if fx not in flst:
flst.append(fx)
# sort them ascending because we will pop within filters.add
entry.filters.add(sorted(flst, key=lambda k:
(-k.priority, k.name)),
context=v)
# lets offer a last break to populate tags and such
for v in _views:
env = v.context(conf, env, data)
# now teh real thing!
for v in _views:
for entry in chain(entrylist, pages, translations, drafts):
entry.context = v
for var in 'entrylist', 'pages', 'translations', 'drafts':
data[var] = HashableList(filter(v.condition, locals()[var])) \
if v.condition else locals()[var]
tt = time.time()
for buf, path in v.generate(conf, env, data):
try:
helpers.mkfile(buf,
path,
time.time() - tt,
ns=v.name,
force=env.options.force,
dryrun=env.options.dryrun)
except UnicodeError:
log.exception(path)
finally:
buf.close()
tt = time.time()
# copy modified/missing assets to output
assets.compile(conf, env)
# wait for unfinished hooks
hooks.shutdown()
# run post hooks (blocks)
hooks.run(conf, env, 'post')
# save conf/environment hash and new/changed/unchanged references
helpers.memoize('Configuration', hash(conf))
helpers.memoize('Environment', hash(env))
refs.save()
# remove abandoned cache files
cache.shutdown()
# print a short summary
log.info('%i new, %i updated, %i skipped [%.2fs]', event.count('create'),
event.count('update'),
event.count('identical') + event.count('skip'),
time.time() - ctime)
