Skip to content

feature: implement -S --stream option #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feature: implement -S --stream option #130

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1ca5fc
cli.py: implement --stream option
Kamilcuk Jul 27, 2024
987b8e8
cli: allow -S option without arguments
Kamilcuk Jul 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 63 additions & 51 deletions jinja2cli/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,12 +242,13 @@ def _load_json5():
}


def render(template_path, data, extensions, strict=False):
def render(template_path, data, extensions, strict=False, stream=False):
from jinja2 import (
__version__ as jinja_version,
Environment,
FileSystemLoader,
StrictUndefined,
BaseLoader,
)

# Starting with jinja2 3.1, `with_` and `autoescape` are no longer
Expand All @@ -262,7 +263,7 @@ def render(template_path, data, extensions, strict=False):
extensions.append(ext)

env = Environment(
loader=FileSystemLoader(os.path.dirname(template_path)),
loader=BaseLoader() if stream else FileSystemLoader(os.path.dirname(template_path)),
extensions=extensions,
keep_trailing_newline=True,
)
Expand All @@ -273,7 +274,8 @@ def render(template_path, data, extensions, strict=False):
env.globals["environ"] = lambda key: force_text(os.environ.get(key))
env.globals["get_context"] = lambda: data

return env.get_template(os.path.basename(template_path)).render(data)
template = env.from_string(template_path.read()) if stream else env.get_template(os.path.basename(template_path))
return template.render(data)


def is_fd_alive(fd):
Expand All @@ -285,53 +287,57 @@ def is_fd_alive(fd):


def cli(opts, args):
template_path, data = args
format = opts.format
if data in ("-", ""):
if data == "-" or (data == "" and is_fd_alive(sys.stdin)):
data = sys.stdin.read()
if format == "auto":
# default to yaml first if available since yaml
# is a superset of json
if has_format("yaml"):
format = "yaml"
else:
format = "json"
else:
path = os.path.join(os.getcwd(), os.path.expanduser(data))
if format == "auto":
ext = os.path.splitext(path)[1][1:]
if has_format(ext):
format = ext
else:
raise InvalidDataFormat(ext)

with open(path) as fp:
data = fp.read()

template_path = os.path.abspath(template_path)

if data:
try:
fn, except_exc, raise_exc = get_format(format)
except InvalidDataFormat:
if format in ("yml", "yaml"):
raise InvalidDataFormat("%s: install pyyaml to fix" % format)
if format == "toml":
raise InvalidDataFormat("toml: install toml to fix")
if format == "xml":
raise InvalidDataFormat("xml: install xmltodict to fix")
if format == "hjson":
raise InvalidDataFormat("hjson: install hjson to fix")
if format == "json5":
raise InvalidDataFormat("json5: install json5 to fix")
raise
try:
data = fn(data) or {}
except except_exc:
raise raise_exc("%s ..." % data[:60])
else:
if opts.stream:
data = {}
template_path = sys.stdin
else:
template_path, data = args
format = opts.format
if data in ("-", ""):
if data == "-" or (data == "" and is_fd_alive(sys.stdin)):
data = sys.stdin.read()
if format == "auto":
# default to yaml first if available since yaml
# is a superset of json
if has_format("yaml"):
format = "yaml"
else:
format = "json"
else:
path = os.path.join(os.getcwd(), os.path.expanduser(data))
if format == "auto":
ext = os.path.splitext(path)[1][1:]
if has_format(ext):
format = ext
else:
raise InvalidDataFormat(ext)

with open(path) as fp:
data = fp.read()

template_path = os.path.abspath(template_path)

if data:
try:
fn, except_exc, raise_exc = get_format(format)
except InvalidDataFormat:
if format in ("yml", "yaml"):
raise InvalidDataFormat("%s: install pyyaml to fix" % format)
if format == "toml":
raise InvalidDataFormat("toml: install toml to fix")
if format == "xml":
raise InvalidDataFormat("xml: install xmltodict to fix")
if format == "hjson":
raise InvalidDataFormat("hjson: install hjson to fix")
if format == "json5":
raise InvalidDataFormat("json5: install json5 to fix")
raise
try:
data = fn(data) or {}
except except_exc:
raise raise_exc("%s ..." % data[:60])
else:
data = {}

extensions = []
for ext in opts.extensions:
Expand Down Expand Up @@ -362,7 +368,7 @@ def cli(opts, args):

out = codecs.getwriter("utf8")(out)

out.write(render(template_path, data, extensions, opts.strict))
out.write(render(template_path, data, extensions, opts.strict, opts.stream))
out.flush()
return 0

Expand Down Expand Up @@ -461,12 +467,18 @@ def main():
metavar="FILE",
action="store",
)
parser.add_option(
"-S",
"--stream",
help="Input template comes from stdin. There is no input data argument",
action="store_true",
)
opts, args = parser.parse_args()

# Dedupe list
opts.extensions = set(opts.extensions)

if len(args) == 0:
if len(args) == 0 and not opts.stream:
parser.print_help()
sys.exit(1)

Expand Down