Skip to content
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

proposing new --format=<format> --out-file=<file.ext> feature #17507

Merged
merged 18 commits into from
Dec 30, 2024
Merged

proposing new --format=<format> --out-file=<file.ext> feature #17507

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
410372a
proposing new --format=file.ext feature
memsharded Dec 19, 2024
8a2a443
change approach and some simplifications
czoido Dec 19, 2024
463493e
remove unused
czoido Dec 19, 2024
0b5a991
minor changes
czoido Dec 19, 2024
859c512
minor changes
czoido Dec 19, 2024
434da37
simplify a bit
czoido Dec 20, 2024
1f72ab9
fix format
czoido Dec 20, 2024
65a1dc1
Merge branch 'develop2' into feature/output_files
czoido Dec 20, 2024
0a06ba3
minor changes
czoido Dec 20, 2024
9f103e0
fix
czoido Dec 20, 2024
2f5af33
Merge branch 'develop2' into feature/output_files
czoido Dec 30, 2024
e50e93e
move colorama deinit/reinit
czoido Dec 30, 2024
04d4a65
add out-file only if formatters
czoido Dec 30, 2024
43bed9a
revert
czoido Dec 30, 2024
f4cb4fe
wip
czoido Dec 30, 2024
7108dd3
do not deinit/reinit if not tty
czoido Dec 30, 2024
44f61e0
clean import
czoido Dec 30, 2024
ac895bf
minor changes
czoido Dec 30, 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
3 changes: 0 additions & 3 deletions conan/api/output.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,10 +294,7 @@ def cli_out_write(data, fg=None, bg=None, endline="\n", indentation=0):
sys.stdout.write(data)
else:
data = f"{' ' * indentation}{data}{endline}"
# https://github.com/conan-io/conan/issues/17245 avoid colorama crash and overhead
colorama.deinit()
sys.stdout.write(data)
colorama.reinit()


class TimedOutput:
Expand Down
30 changes: 21 additions & 9 deletions conan/cli/command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import argparse
import textwrap
from contextlib import redirect_stdout

import colorama

from conan.api.output import ConanOutput
from conan.errors import ConanException
Expand Down Expand Up @@ -63,10 +66,13 @@ def _help_formatters(self):
return [formatter for formatter in self._formatters if formatter != "text"]

def _init_formatters(self, parser):
formatters = self._help_formatters
if formatters:
help_message = "Select the output format: {}".format(", ".join(formatters))
if self._help_formatters:
help_message = "Select the output format: {}".format(", ".join(self._help_formatters))
parser.add_argument('-f', '--format', action=OnceArgument, help=help_message)
# Add the out-file argument if any formatters exist, even the default one not shown in help
if self._formatters:
czoido marked this conversation as resolved.
Show resolved Hide resolved
parser.add_argument("--out-file", action=OnceArgument,
help="Write the output of the command to the specified file instead of stdout.")

@property
def name(self):
Expand All @@ -83,19 +89,25 @@ def doc(self):
def _format(self, parser, info, *args):
parser_args, _ = parser.parse_known_args(*args)

default_format = "text"
try:
formatarg = parser_args.format or default_format
except AttributeError:
formatarg = default_format
formatarg = getattr(parser_args, "format", None) or "text"
out_file = getattr(parser_args, "out_file", None)

try:
formatter = self._formatters[formatarg]
except KeyError:
raise ConanException("{} is not a known format. Supported formatters are: {}".format(
formatarg, ", ".join(self._help_formatters)))

formatter(info)
if out_file:
with open(out_file, 'w') as f:
with redirect_stdout(f):
formatter(info)
ConanOutput().info(f"Formatted output saved to '{out_file}'")
else:
# https://github.com/conan-io/conan/issues/17245 avoid colorama crash and overhead
colorama.deinit()
czoido marked this conversation as resolved.
Show resolved Hide resolved
formatter(info)
colorama.reinit()

@staticmethod
def _dispatch_errors(info):
Expand Down
31 changes: 31 additions & 0 deletions test/integration/command_v2/test_output.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import json

from conan.test.assets.genconanfile import GenConanfile
from conan.test.utils.tools import TestClient
from conan.test.utils.env import environment_update
Expand Down Expand Up @@ -260,3 +262,32 @@ def test_exception_errors(self):
t.run("create . -vquiet", assert_error=True)
assert "ERROR: Tagged error" not in t.out
assert "ConanException: Untagged error" not in t.out


def test_formatter_redirection_to_file():
c = TestClient(light=True)
c.save({"conanfile.py": GenConanfile("pkg", "0.1")})

c.run("config home --out-file=cmd_out.txt")
assert "Formatted output saved to 'cmd_out.txt'" in c.out
cmd_out = c.load("cmd_out.txt")
assert f"{c.cache_folder}" in cmd_out
assert not f"{c.cache_folder}" in c.stdout

c.run("graph info . --format=json --out-file=graph.json")
assert "Formatted output saved to 'graph.json'" in c.out
graph = json.loads(c.load("graph.json"))
assert len(graph["graph"]["nodes"]) == 1
assert not "nodes" in c.stdout

c.run("graph info . --format=html --out-file=graph.html")
assert "Formatted output saved to 'graph.html'" in c.out
html = c.load("graph.html")
assert "<head>" in html
assert not "<head>" in c.stdout

c.run("install . --format=json --out-file=graph.json")
assert "Formatted output saved to 'graph.json'" in c.out
graph = json.loads(c.load("graph.json"))
assert len(graph["graph"]["nodes"]) == 1
assert not "nodes" in c.stdout
Loading