def run(conf, env, options):
"""Attention: this function may eat your data! Every create, changed
or skip event call tracks automatically files. After generation,
``acrylamid clean`` will call this function and remove untracked files.
- with OUTPUT_IGNORE you can specify a list of patterns which are ignored.
- you can use --dry-run to see what would have been removed
- by default acrylamid does NOT call this function
- it removes silently every empty directory
:param conf: user configuration
:param env: acrylamid environment
:param force: remove all tracked files, too
:param dryrun: don't delete, just show what would have been done
"""
force=options.force
dryrun=options.dryrun
# we don't bother the user here
log.setLevel(env.options.verbosity+5)
env.options.ignore = True
# register our track function to events
event.register(track, to=['create', 'update', 'skip', 'identical'])
# run a silent compile
commands.compile(conf, env, dryrun=True, force=False)
log.setLevel(env.options.verbosity)
global tracked
for root, dirs, files in os.walk(conf['output_dir'], topdown=True):
found = set([join(root, p) for p in files
if not readers.ignored(root, p, conf['output_ignore'], conf['output_dir'])])
for p in found.difference(tracked):
if not dryrun:
os.remove(p)
event.remove(p)
if force:
for p in found.intersection(tracked):
if not dryrun:
os.remove(p)
event.remove(p)
# don't visit excluded dirs
for dir in dirs[:]:
if readers.ignored(root, dir+'/', conf['output_ignore'], conf['output_dir']):
dirs.remove(dir)
# remove empty directories
for root, dirs, files in os.walk(conf['output_dir'], topdown=True):
for p in (join(root, k) for k in dirs):
try:
os.rmdir(p)
except OSError:
pass
def Acryl():
"""The main function that dispatches the CLI. We use :class:`AcrylFormatter`
as custom help formatter that ommits the useless list of available subcommands
and their aliases.
All flags from acrylamid --help are also available in subcommands altough not
explicitely printed in their help."""
parser = argparse.ArgumentParser(
parents=[], formatter_class=AcrylFormatter
)
parser.add_argument("-v", "--verbose", action="store_const", dest="verbosity",
help="more verbose", const=log.SKIP, default=log.INFO)
parser.add_argument("-q", "--quiet", action="store_const", dest="verbosity",
help="less verbose", const=log.WARN)
parser.add_argument("-C", "--no-color", action="store_false", dest="colors",
help="disable color", default=True)
parser.add_argument("--conf", dest="conf", help="alternate conf.py",
default="conf.py", metavar="/path/to/conf")
parser.add_argument("--version", action="version",
version=colors.blue('Acrylamid ') + dist.version)
subparsers = parser.add_subparsers(dest="parser")
# a repeat yourself of default arguments but not visible on subcommand --help
default = argparse.ArgumentParser(add_help=False)
default.add_argument("-v", "--verbose", action="store_const", dest="verbosity",
help=argparse.SUPPRESS, const=log.SKIP, default=log.INFO)
default.add_argument("-q", "--quiet", action="store_const", dest="verbosity",
help=argparse.SUPPRESS, const=log.WARN)
default.add_argument("-C", "--no-color", action="store_false", dest="colors",
help=argparse.SUPPRESS, default=True)
# --- gen params --- #
generate = subparsers.add_parser('compile', help='compile blog', parents=[default])
generate.add_argument("-f", "--force", action="store_true", dest="force",
help="clear cache before compilation", default=False)
generate.add_argument("-n", "--dry-run", dest="dryrun", action='store_true',
help="show what would have been compiled", default=False)
generate.add_argument("--ignore", dest="ignore", action="store_true",
help="ignore critical errors", default=False)
generate.add_argument("--search", dest="search", action="store_true",
help="build search index", default=False)
# --- webserver params --- #
view = subparsers.add_parser('view', help="fire up built-in webserver", parents=[default])
view.add_argument("-p", "--port", dest="port", type=int, default=8000,
help="webserver port")
# --- aco params --- #
autocompile = subparsers.add_parser('autocompile', help="automatic compilation and serving",
parents=[default])
autocompile.add_argument("-f", "--force", action="store_true", dest="force",
help="clear cache before compilation", default=False)
autocompile.add_argument("-n", "--dry-run", dest="dryrun", action='store_true',
help="show what would have been compiled", default=False)
autocompile.add_argument("--ignore", dest="ignore", action="store_true",
help="ignore critical errors", default=False)
autocompile.add_argument("--search", dest="search", action="store_true",
help="build search index", default=False)
autocompile.add_argument("-p", "--port", dest="port", type=int, default=8000,
help="webserver port")
for alias in ('co', 'gen', 'generate'):
subparsers._name_parser_map[alias] = generate
for alias in ('serve', 'srv'):
subparsers._name_parser_map[alias] = view
subparsers._name_parser_map['aco'] = autocompile
# temporary log to catch issues during task initialization
log.init('temporary', level=log.WARN, colors=False)
# initialize other tasks
tasks.initialize(subparsers, default)
# parse args
options = parser.parse_args()
# initialize colored logger
log.init('acrylamid', level=options.verbosity, colors=options.colors)
env = core.Environment({'author': __author__, 'url': __url__,
'options': options, 'globals': Struct()})
try:
conf = core.load(options.conf)
except IOError:
log.critical('no conf.py found. Are you inside your blog?')
sys.exit(1)
except Exception as e:
log.critical("%s in `conf.py`" % e.__class__.__name__)
traceback.print_exc(file=sys.stdout)
sys.exit(1)
# -- run -- #
if options.parser in ('gen', 'generate', 'co', 'compile'):
log.setLevel(options.verbosity)
try:
commands.compile(conf, env)
except AcrylamidException as e:
log.exception(e.args[0])
sys.exit(1)
elif options.parser in ('srv', 'serve', 'view'):
from acrylamid.lib.httpd import Webserver
ws = partial(Webserver, options.port, conf['output_dir'])
ws = ws(log.info) if options.verbosity < 20 else ws(); ws.start()
log.info(' * Running on http://127.0.0.1:%i/' % options.port)
try:
while True:
time.sleep(1)
except (SystemExit, KeyboardInterrupt) as e:
ws.kill_received = True
sys.exit(0)
elif options.parser in ('aco', 'autocompile'):
from acrylamid.lib.httpd import Webserver
# XXX compile on request _or_ use inotify/fsevent
ws = Webserver(options.port, conf['output_dir']); ws.start()
log.info(' * Running on http://127.0.0.1:%i/' % options.port)
try:
commands.autocompile(ws, conf, env)
except (SystemExit, KeyboardInterrupt) as e:
ws.kill_received = True
log.error(e.args[0])
traceback.print_exc(file=sys.stdout)
sys.exit(0)
elif options.parser in tasks.collected:
try:
tasks.collected[options.parser](conf, env, options)
except AcrylamidException as e:
log.exception('uncaught exception')
sys.exit(1)
else:
log.critical('No such command!')
sys.exit(2)
sys.exit(0)
def run(conf, env, options):
"""Attention: this function may eat your data! Every create, changed
or skip event call tracks automatically files. After generation,
``acrylamid clean`` will call this function and remove untracked files.
- with OUTPUT_IGNORE you can specify a list of patterns which are ignored.
- you can use --dry-run to see what would have been removed
- by default acrylamid does NOT call this function
- it removes silently every empty directory
:param conf: user configuration
:param env: acrylamid environment
:param force: remove all tracked files, too
:param dryrun: don't delete, just show what would have been done
"""
force = options.force
dryrun = options.dryrun
# we don't bother the user here
log.setLevel(env.options.verbosity + 5)
env.options.ignore = True
# register our track function to events
event.register(track, to=['create', 'update', 'skip', 'identical'])
# run a silent compile
commands.compile(conf, env, dryrun=True, force=False)
log.setLevel(env.options.verbosity)
global tracked
for root, dirs, files in os.walk(conf['output_dir'], topdown=True):
found = set([
join(root, p) for p in files if not readers.ignored(
root, p, conf['output_ignore'], conf['output_dir'])
])
for p in found.difference(tracked):
if not dryrun:
os.remove(p)
event.remove(p)
if force:
for p in found.intersection(tracked):
if not dryrun:
os.remove(p)
event.remove(p)
# don't visit excluded dirs
for dir in dirs[:]:
if readers.ignored(root, dir + '/', conf['output_ignore'],
conf['output_dir']):
dirs.remove(dir)
# remove empty directories
for root, dirs, files in os.walk(conf['output_dir'], topdown=True):
for p in (join(root, k) for k in dirs):
try:
os.rmdir(p)
except OSError:
pass
def Acryl():
"""The main function that dispatches the CLI. We use :class:`AcrylFormatter`
as custom help formatter that ommits the useless list of available subcommands
and their aliases.
All flags from acrylamid --help are also available in subcommands altough not
explicitely printed in their help."""
parser = argparse.ArgumentParser(
parents=[], formatter_class=AcrylFormatter
)
parser.add_argument("-v", "--verbose", action="store_const", dest="verbosity",
help="more verbose", const=log.SKIP, default=log.INFO)
parser.add_argument("-q", "--quiet", action="store_const", dest="verbosity",
help="less verbose", const=log.WARN)
parser.add_argument("-C", "--no-color", action="store_false", dest="colors",
help="disable color", default=True)
parser.add_argument("--version", action="version",
version=colors.blue('acrylamid ') + __version__)
subparsers = parser.add_subparsers(dest="parser")
# a repeat yourself of default arguments but not visible on subcommand --help
default = argparse.ArgumentParser(add_help=False)
default.add_argument("-v", "--verbose", action="store_const", dest="verbosity",
help=argparse.SUPPRESS, const=log.SKIP, default=log.INFO)
default.add_argument("-q", "--quiet", action="store_const", dest="verbosity",
help=argparse.SUPPRESS, const=log.WARN)
default.add_argument("-C", "--no-color", action="store_false", dest="colors",
help=argparse.SUPPRESS, default=True)
# --- gen params --- #
generate = subparsers.add_parser('compile', help='compile blog', parents=[default])
generate.add_argument("-f", "--force", action="store_true", dest="force",
help="clear cache before compilation", default=False)
generate.add_argument("-n", "--dry-run", dest="dryrun", action='store_true',
help="show what would have been compiled", default=False)
generate.add_argument("-i", "--ignore", dest="ignore", action="store_true",
help="ignore critical errors", default=False)
# --- webserver params --- #
view = subparsers.add_parser('view', help="fire up built-in webserver", parents=[default])
view.add_argument("-p", "--port", dest="port", type=int, default=8000,
help="webserver port")
# --- aco params --- #
autocompile = subparsers.add_parser('autocompile', help="automatic compilation and serving",
parents=[default])
autocompile.add_argument("-f", "--force", action="store_true", dest="force",
help="clear cache before compilation", default=False)
autocompile.add_argument("-n", "--dry-run", dest="dryrun", action='store_true',
help="show what would have been compiled", default=False)
autocompile.add_argument("-i", "--ignore", dest="ignore", action="store_true",
help="ignore critical errors", default=False)
autocompile.add_argument("-p", "--port", dest="port", type=int, default=8000,
help="webserver port")
for alias in ('co', 'gen', 'generate'):
subparsers._name_parser_map[alias] = generate
for alias in ('serve', 'srv'):
subparsers._name_parser_map[alias] = view
subparsers._name_parser_map['aco'] = autocompile
new = subparsers.add_parser('new', help="create a new entry", parents=[default],
epilog=("Takes all leading [args] as title or prompt if none given. creates "
"a new entry based on your PERMALINK_FORMAT and opens it with your "
"favourite $EDITOR."))
new.add_argument("title", nargs="*", default='')
# initialize other tasks
tasks.initialize(subparsers, default)
# parse args
options = parser.parse_args()
# initialize colored logger
log.init('acrylamid', level=options.verbosity, colors=options.colors)
env = Struct({'version': __version__, 'author': __author__, 'url': __url__})
env['options'] = options
env['globals'] = Struct()
# -- init -- #
# TODO: acrylamid init --layout_dir=somedir to overwrite defaults
if options.parser in ('init', ):
tasks.collected[options.parser](env, options)
sys.exit(0)
# -- teh real thing -- #
conf = Struct(defaults.conf)
try:
ns = dict([(k.upper(), v) for k, v in defaults.conf.iteritems()])
os.chdir(os.path.dirname(find('conf.py', os.getcwd())))
execfile('conf.py', ns)
conf.update(dict([(k.lower(), ns[k]) for k in ns if k.upper() == k]))
except IOError:
log.critical('no conf.py found. Try "acrylamid init".')
sys.exit(1)
except Exception as e:
log.critical("%s in `conf.py`" % e.__class__.__name__)
traceback.print_exc(file=sys.stdout)
sys.exit(1)
conf['output_dir'] = conf.get('output_dir', 'output/')
conf['content_dir'] = conf.get('content_dir', 'content/')
conf['layout_dir'] = conf.get('layout_dir', 'layouts/')
# -- run -- #
if options.parser in ('gen', 'generate', 'co', 'compile'):
log.setLevel(options.verbosity)
try:
commands.compile(conf, env, **options.__dict__)
except AcrylamidException as e:
log.fatal(e.args[0])
sys.exit(1)
elif options.parser in ('new', 'create'):
try:
commands.new(conf, env, title=' '.join(options.title), prompt=log.level()<log.WARN)
except AcrylamidException as e:
log.fatal(e.args[0])
sys.exit(1)
elif options.parser in ('srv', 'serve', 'view'):
from acrylamid.lib.httpd import Webserver
ws = Webserver(options.port, conf['output_dir']); ws.start()
log.info(' * Running on http://127.0.0.1:%i/' % options.port)
try:
while True:
time.sleep(1)
except (SystemExit, KeyboardInterrupt, Exception) as e:
ws.kill_received = True
sys.exit(0)
elif options.parser in ('aco', 'autocompile'):
from acrylamid.lib.httpd import Webserver
# XXX compile on request _or_ use inotify/fsevent
ws = Webserver(options.port, conf['output_dir']); ws.start()
log.info(' * Running on http://127.0.0.1:%i/' % options.port)
try:
commands.autocompile(ws, conf, env, **options.__dict__)
except (SystemExit, KeyboardInterrupt, Exception) as e:
ws.kill_received = True
log.error(e.args[0])
traceback.print_exc(file=sys.stdout)
sys.exit(0)
elif options.parser in tasks.collected:
try:
tasks.collected[options.parser](conf, env, options)
except AcrylamidException as e:
log.critical(e.args[0])
sys.exit(1)
else:
log.critical('No such command!')
sys.exit(2)
sys.exit(0)
sys.exit(1)
except Exception, e:
log.critical("%s in `conf.py`" % e.__class__.__name__)
traceback.print_exc(file=sys.stdout)
sys.exit(1)
conf['output_dir'] = conf.get('output_dir', 'output/')
conf['content_dir'] = conf.get('content_dir', 'content/')
conf['layout_dir'] = conf.get('layout_dir', 'layouts/')
assert defaults.check_conf(conf)
conf.update(dict((k, v) for k, v in options.__dict__.iteritems() if v != None))
# -- run -- #
if options.parser in ('gen', 'generate', 'co', 'compile'):
log.setLevel(options.verbosity)
try:
commands.compile(conf, env, **options.__dict__)
except AcrylamidException as e:
log.fatal(e.args[0])
sys.exit(1)
elif options.parser in ('new', 'create'):
try:
commands.new(conf, env, title=' '.join(options.title), prompt=log.level()<log.WARN)
except AcrylamidException as e:
log.fatal(e.args[0])
sys.exit(1)
elif options.parser in ('srv', 'serve', 'view'):
from acrylamid.lib.httpd import Webserver
def Acryl():
"""The main function that dispatches the CLI. We use :class:`AcrylFormatter`
as custom help formatter that ommits the useless list of available subcommands
and their aliases.
All flags from acrylamid --help are also available in subcommands altough not
explicitely printed in their help."""
parser = argparse.ArgumentParser(parents=[], formatter_class=AcrylFormatter)
parser.add_argument(
"-v", "--verbose", action="store_const", dest="verbosity", help="more verbose", const=log.SKIP, default=log.INFO
)
parser.add_argument("-q", "--quiet", action="store_const", dest="verbosity", help="less verbose", const=log.WARN)
parser.add_argument("-C", "--no-color", action="store_false", dest="colors", help="disable color", default=True)
parser.add_argument("--version", action="version", version=colors.blue("acrylamid ") + __version__)
subparsers = parser.add_subparsers(dest="parser")
# a repeat yourself of default arguments but not visible on subcommand --help
default = argparse.ArgumentParser(add_help=False)
default.add_argument(
"-v",
"--verbose",
action="store_const",
dest="verbosity",
help=argparse.SUPPRESS,
const=log.SKIP,
default=log.INFO,
)
default.add_argument(
"-q", "--quiet", action="store_const", dest="verbosity", help=argparse.SUPPRESS, const=log.WARN
)
default.add_argument("-C", "--no-color", action="store_false", dest="colors", help=argparse.SUPPRESS, default=True)
# --- gen params --- #
generate = subparsers.add_parser("compile", help="compile blog", parents=[default])
generate.add_argument(
"-f", "--force", action="store_true", dest="force", help="clear cache before compilation", default=False
)
generate.add_argument(
"-n", "--dry-run", dest="dryrun", action="store_true", help="show what would have been compiled", default=False
)
generate.add_argument(
"-i", "--ignore", dest="ignore", action="store_true", help="ignore critical errors", default=False
)
# --- webserver params --- #
view = subparsers.add_parser("view", help="fire up built-in webserver", parents=[default])
view.add_argument("-p", "--port", dest="port", type=int, default=8000, help="webserver port")
# --- aco params --- #
autocompile = subparsers.add_parser("autocompile", help="automatic compilation and serving", parents=[default])
autocompile.add_argument(
"-f", "--force", action="store_true", dest="force", help="clear cache before compilation", default=False
)
autocompile.add_argument(
"-n", "--dry-run", dest="dryrun", action="store_true", help="show what would have been compiled", default=False
)
autocompile.add_argument(
"-i", "--ignore", dest="ignore", action="store_true", help="ignore critical errors", default=False
)
autocompile.add_argument("-p", "--port", dest="port", type=int, default=8000, help="webserver port")
for alias in ("co", "gen", "generate"):
subparsers._name_parser_map[alias] = generate
for alias in ("serve", "srv"):
subparsers._name_parser_map[alias] = view
subparsers._name_parser_map["aco"] = autocompile
# initialize other tasks
tasks.initialize(subparsers, default)
# parse args
options = parser.parse_args()
# initialize colored logger
log.init("acrylamid", level=options.verbosity, colors=options.colors)
env = Struct({"version": __version__, "author": __author__, "url": __url__})
env["options"] = options
env["globals"] = Struct()
# -- init -- #
try:
if options.parser in ("init",):
tasks.collected[options.parser](env, options)
sys.exit(0)
except AcrylamidException as e:
log.fatal(e.args[0])
sys.exit(1)
# -- teh real thing -- #
conf = Struct(defaults.conf)
try:
ns = dict([(k.upper(), v) for k, v in defaults.conf.iteritems()])
os.chdir(os.path.dirname(find("conf.py", os.getcwd())))
execfile("conf.py", ns)
conf.update(dict([(k.lower(), ns[k]) for k in ns if k.upper() == k]))
except IOError:
log.critical('no conf.py found. Try "acrylamid init".')
sys.exit(1)
except Exception as e:
log.critical("%s in `conf.py`" % e.__class__.__name__)
traceback.print_exc(file=sys.stdout)
sys.exit(1)
# -- run -- #
if options.parser in ("gen", "generate", "co", "compile"):
log.setLevel(options.verbosity)
try:
commands.compile(conf, env, **options.__dict__)
except AcrylamidException as e:
log.fatal(e.args[0])
sys.exit(1)
elif options.parser in ("srv", "serve", "view"):
from acrylamid.lib.httpd import Webserver
ws = partial(Webserver, options.port, conf["output_dir"])
ws = ws(log.info) if options.verbosity < 20 else ws()
ws.start()
log.info(" * Running on http://127.0.0.1:%i/" % options.port)
try:
while True:
time.sleep(1)
except (SystemExit, KeyboardInterrupt, Exception) as e:
ws.kill_received = True
sys.exit(0)
elif options.parser in ("aco", "autocompile"):
from acrylamid.lib.httpd import Webserver
# XXX compile on request _or_ use inotify/fsevent
ws = Webserver(options.port, conf["output_dir"])
ws.start()
log.info(" * Running on http://127.0.0.1:%i/" % options.port)
try:
commands.autocompile(ws, conf, env, **options.__dict__)
except (SystemExit, KeyboardInterrupt, Exception) as e:
ws.kill_received = True
log.error(e.args[0])
traceback.print_exc(file=sys.stdout)
sys.exit(0)
elif options.parser in tasks.collected:
try:
tasks.collected[options.parser](conf, env, options)
except AcrylamidException as e:
log.critical(e.args[0])
sys.exit(1)
else:
log.critical("No such command!")
sys.exit(2)
sys.exit(0)