inji.cli

Complexity

Total Complexity

20

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Functions

Rating	Name	Duplication	Size	Complexity
A	_version()	0	2	1
A	pkg_location()	0	2	1
A	cli_location()	0	2	1
A	sigint_handler()	0	4	1
B	cli_args()	0	55	5
C	main()	0	72	11

#!/usr/bin/env python3

# -*- coding: utf-8 -*-

# NAME

# inji - Render jina2 templates to stdout

import ast
import argparse
import atexit
import fnmatch
import json
import locale
import os
from   os.path import abspath, dirname, join
import pkg_resources
import re
import shutil
import signal
import sys
import tempfile

from .engine import TemplateEngine
from . import utils

def pkg_location():
  return abspath(dirname(__file__))

def cli_location():
  return abspath(join(pkg_location(), '../bin/inji'))

def _version():
  return pkg_resources.require(__package__)[0].version

__version__ = _version()

def cli_args():
  parser = argparse.ArgumentParser(
      description='inji - render jinja templates'
    )
  required = parser.add_argument_group('required arguments')

  parser.add_argument('-j', '--json-config', '-c',
    action = 'store', required=False,
    type=lambda x: utils.json_parse(x),
    dest='json_string',
    help="-c '{ \"foo\": \"bar\", \"fred\": \"wilma\" }'"
  )

  parser.add_argument('-k', '--kv-config', '-d',
    action = 'append', required=False,
    type=lambda x: utils.kv_parse(x),
    dest='kv_pair',
    help='-d foo=bar -d fred=wilma'
  )

  parser.add_argument('-o', '--overlay-dir',
    action = 'append', required=False, type=lambda p, t='dir': utils.path(p, t),
    dest='overlay_dir', default=[],
    help='/path/to/overlay/'
  )

  parser.add_argument('-v', '-p', '--vars-file', '--vars',
    action = 'append', required=False, type=lambda p, t='file': utils.path(p, t),
    dest='vars_file', default=[],
    help='/path/to/vars.yaml'
  )

  parser.add_argument('--strict-mode', '-s',
    action = 'store', required=False, type=str,
    dest='undefined_variables_mode', default='strict',
    choices=[ 'strict', 'empty', 'keep',
              'StrictUndefined', 'Undefined', 'DebugUndefined' ],
    help='Refer to http://jinja.pocoo.org/docs/2.10/api/#undefined-types'
  )

  parser.add_argument('--version',
    action = 'version',
    version=_version(),
    help='print version number ({})'.format(_version())
  )

  parser.add_argument('template',
    nargs='*',
    action = 'store',
    type=utils.file_or_stdin,
    default='-',
    help='/path/to/template.j2 (defaults to -)'
  )

  return parser.parse_args()


def sigint_handler(signum, frame):  # pragma: no cover # despite being covered
  """ Handle SIGINT, ctrl-c gracefully """
  signal.signal(signum, signal.SIG_IGN) # ignore subsequent ctrl-c's
  sys.exit( 128 + signal.SIGINT )       # 130 by convention


def main():
  """ Our main method """

  # cleanly handle ctrl-c's
  signal.signal(signal.SIGINT, sigint_handler)

  assert sys.version_info >= (3,5), 'Python version ({}.{} !>= 3.5)'.format(
    sys.version_info.major,
    sys.version_info.minor
  )

  args = cli_args()

  # this holds all the possible vars files we are told about or imply
  vars_files = []

  # context in the local configuration files - p5
  vars_files += fnmatch.filter(os.listdir('.'), "*inji.y*ml")

  # context in the overlay directories - p4
  for d in args.overlay_dir:
    files = list(utils.recursive_iglob(d, '*.y*ml'))
    if len(files):
      loc = locale.getlocale()
      locale.setlocale(locale.LC_ALL, 'C') # Using LC_ALL=C POSIX locale
      files.sort()                         # We force the sort collation of files
      locale.setlocale(locale.LC_ALL, loc) # And then reset it back
      vars_files += files

  # context from named vars files - p3
  vars_files += args.vars_file

  # This will hold the final vars dict merged from various available sources
  context = {}
  for file in vars_files:
    context.update(utils.read_context(file))

  # context from environment variables - p2
  context.update(os.environ)

  # context at the command line (either JSON or KV type) - p1
  if args.json_string:
    context.update(args.json_string)

  if args.kv_pair:
    # we've appended dicts into args.kv_pair .. unpack them in order
    for d in args.kv_pair:
      context.update(d)

  if '-' in args.template:
    # Template passed in via stdin. Create template as a tempfile and use it
    # instead but since includes are possible (though not likely), we have to do
    # this in an isolated tmpdir container to prevent inadvertent reading of
    # includes not meant to be read.
    tmpdir = tempfile.mkdtemp(prefix=__name__)
    atexit.register(shutil.rmtree, tmpdir)

    _, tmpfile = tempfile.mkstemp(prefix='stdin-', dir=tmpdir, text=True)
    atexit.register(os.remove, tmpfile)

    with open(tmpfile, "a+") as f:
      f.write(sys.stdin.read())

    # Yes, even if user specifies multiple other templates, the fact he
    # specified '-' just once means we only deal with one template i.e. '-'
    args.template = [tmpfile]

  engine = TemplateEngine( undefined_variables_mode_behaviour=args.undefined_variables_mode )

  for template in args.template:
    for block in engine.render( template=template, context=context ):
      print(block)