python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-21 00:19:42 +02:00
Code Issues Releases Activity

fix exit codes

Browse Source
This commit is contained in:
Kelly Brazil
2022-10-04 10:10:59 -07:00
parent 0306b6b73b
commit 46fdc457fc
1 changed files with 38 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
jc/cli.py
View File

@ -60,7 +60,7 @@ class JcCli():
__slots__ = ( __slots__ = (
'data_in', 'data_out', 'options', 'args', 'parser_module', 'parser_name', 'indent', 'pad', 'data_in', 'data_out', 'options', 'args', 'parser_module', 'parser_name', 'indent', 'pad',
'env_colors', 'custom_colors', 'show_hidden', 'ascii_only', 'json_separators', 'env_colors', 'custom_colors', 'show_hidden', 'ascii_only', 'json_separators',
'json_indent', 'jc_exit', 'JC_ERROR_EXIT', 'exit_code', 'run_timestamp', 'about', 'debug', 'json_indent', 'jc_exit', 'JC_ERROR_EXIT', 'run_timestamp', 'about', 'debug',
'verbose_debug', 'force_color', 'mono', 'help_me', 'pretty', 'quiet', 'ignore_exceptions', 'verbose_debug', 'force_color', 'mono', 'help_me', 'pretty', 'quiet', 'ignore_exceptions',
'raw', 'meta_out', 'unbuffer', 'version_info', 'yaml_output', 'bash_comp', 'zsh_comp', 'raw', 'meta_out', 'unbuffer', 'version_info', 'yaml_output', 'bash_comp', 'zsh_comp',
'magic_found_parser', 'magic_options', 'magic_run_command', 'magic_run_command_str', 'magic_found_parser', 'magic_options', 'magic_run_command', 'magic_run_command_str',
@ -84,7 +84,6 @@ class JcCli():
self.json_indent = None self.json_indent = None
self.jc_exit = 0 self.jc_exit = 0
self.JC_ERROR_EXIT = 100 self.JC_ERROR_EXIT = 100
self.exit_code = 0
self.run_timestamp = None self.run_timestamp = None
# cli options # cli options
@ -337,10 +336,12 @@ class JcCli():
self.json_indent = 2 self.json_indent = 2
self.json_separators = None self.json_separators = None
j_string = json.dumps(self.data_out, j_string = json.dumps(
self.data_out,
indent=self.json_indent, indent=self.json_indent,
separators=self.json_separators, separators=self.json_separators,
ensure_ascii=self.ascii_only) ensure_ascii=self.ascii_only
)
if not self.mono: if not self.mono:
# set colors # set colors
@ -432,14 +433,16 @@ class JcCli():
Use subprocess to run the user's command. Returns the STDOUT, STDERR, Use subprocess to run the user's command. Returns the STDOUT, STDERR,
and the Exit Code as a tuple. and the Exit Code as a tuple.
""" """
proc = subprocess.Popen(self.magic_run_command, proc = subprocess.Popen(
self.magic_run_command,
stdout=subprocess.PIPE, stdout=subprocess.PIPE,
stderr=subprocess.PIPE, stderr=subprocess.PIPE,
close_fds=False, # Allows inheriting file descriptors; close_fds=False, # Allows inheriting file descriptors
universal_newlines=True, # useful for process substitution universal_newlines=True, # which is useful for process substitution
encoding='UTF-8') encoding='UTF-8'
self.magic_stdout, self.magic_stderr = proc.communicate() )
self.magic_stdout, self.magic_stderr = proc.communicate()
self.magic_stdout = self.magic_stdout or '\n' self.magic_stdout = self.magic_stdout or '\n'
self.magic_returncode = proc.returncode self.magic_returncode = proc.returncode
@ -452,9 +455,11 @@ class JcCli():
""" """
if self.magic_run_command: if self.magic_run_command:
try: try:
self.magic_run_command_str = shlex.join(self.magic_run_command) # python 3.8+ # python 3.8+
self.magic_run_command_str = shlex.join(self.magic_run_command)
except AttributeError: except AttributeError:
self.magic_run_command_str = ' '.join(self.magic_run_command) # older python versions # older python versions
self.magic_run_command_str = ' '.join(self.magic_run_command)
if self.magic_run_command_str.startswith('/proc'): if self.magic_run_command_str.startswith('/proc'):
try: try:
@ -470,7 +475,7 @@ class JcCli():
f'"{self.magic_run_command_str}" file could not be opened: {error_msg}.' f'"{self.magic_run_command_str}" file could not be opened: {error_msg}.'
]) ])
self.jc_exit = self.JC_ERROR_EXIT self.jc_exit = self.JC_ERROR_EXIT
sys.exit(self.combined_exit_code()) self.compute_exit_code_and_quit()
except Exception: except Exception:
if self.debug: if self.debug:
@ -480,7 +485,7 @@ class JcCli():
f'"{self.magic_run_command_str}" file could not be opened. For details use the -d or -dd option.' f'"{self.magic_run_command_str}" file could not be opened. For details use the -d or -dd option.'
]) ])
self.jc_exit = self.JC_ERROR_EXIT self.jc_exit = self.JC_ERROR_EXIT
sys.exit(self.combined_exit_code()) self.compute_exit_code_and_quit()
elif self.magic_found_parser: elif self.magic_found_parser:
try: try:
@ -497,7 +502,7 @@ class JcCli():
f'"{self.magic_run_command_str}" command could not be run: {error_msg}.' f'"{self.magic_run_command_str}" command could not be run: {error_msg}.'
]) ])
self.jc_exit = self.JC_ERROR_EXIT self.jc_exit = self.JC_ERROR_EXIT
sys.exit(self.combined_exit_code()) self.compute_exit_code_and_quit()
except Exception: except Exception:
if self.debug: if self.debug:
@ -507,11 +512,12 @@ class JcCli():
f'"{self.magic_run_command_str}" command could not be run. For details use the -d or -dd option.' f'"{self.magic_run_command_str}" command could not be run. For details use the -d or -dd option.'
]) ])
self.jc_exit = self.JC_ERROR_EXIT self.jc_exit = self.JC_ERROR_EXIT
sys.exit(self.combined_exit_code()) self.compute_exit_code_and_quit()
elif self.magic_run_command is not None: elif self.magic_run_command is not None:
utils.error_message([f'"{self.magic_run_command_str}" cannot be used with Magic syntax. Use "jc -h" for help.']) utils.error_message([f'"{self.magic_run_command_str}" cannot be used with Magic syntax. Use "jc -h" for help.'])
sys.exit(self.combined_exit_code()) self.jc_exit = self.JC_ERROR_EXIT
self.compute_exit_code_and_quit()
def find_parser(self): def find_parser(self):
if self.magic_found_parser: if self.magic_found_parser:
@ -531,12 +537,12 @@ class JcCli():
if not found: if not found:
utils.error_message(['Missing or incorrect arguments. Use "jc -h" for help.']) utils.error_message(['Missing or incorrect arguments. Use "jc -h" for help.'])
self.jc_exit = self.JC_ERROR_EXIT self.jc_exit = self.JC_ERROR_EXIT
sys.exit(self.combined_exit_code()) self.compute_exit_code_and_quit()
if sys.stdin.isatty() and self.magic_stdout is None: if sys.stdin.isatty() and self.magic_stdout is None:
utils.error_message(['Missing piped data. Use "jc -h" for help.']) utils.error_message(['Missing piped data. Use "jc -h" for help.'])
self.jc_exit = self.JC_ERROR_EXIT self.jc_exit = self.JC_ERROR_EXIT
sys.exit(self.combined_exit_code()) self.compute_exit_code_and_quit()
def streaming_parse_and_print(self): def streaming_parse_and_print(self):
"""only supports UTF-8 string data for now""" """only supports UTF-8 string data for now"""
@ -556,8 +562,6 @@ class JcCli():
self.safe_print_out() self.safe_print_out()
sys.exit(self.combined_exit_code())
def standard_parse_and_print(self): def standard_parse_and_print(self):
"""supports binary and UTF-8 string data""" """supports binary and UTF-8 string data"""
self.data_in = self.magic_stdout or sys.stdin.buffer.read() self.data_in = self.magic_stdout or sys.stdin.buffer.read()
@ -580,15 +584,15 @@ class JcCli():
self.add_metadata_to_output() self.add_metadata_to_output()
self.safe_print_out() self.safe_print_out()
sys.exit(self.combined_exit_code())
def combined_exit_code(self): def compute_exit_code_and_quit(self):
self.exit_code = self.magic_returncode + self.jc_exit exit_code = self.magic_returncode + self.jc_exit
self.exit_code = min(self.exit_code, 255) exit_code = min(exit_code, 255)
sys.exit(exit_code)
def add_metadata_to_output(self): def add_metadata_to_output(self):
""" """
This function mutates a list or dict in place. If the _jc_meta field This function mutates data_out in place. If the _jc_meta field
does not already exist, it will be created with the metadata fields. If does not already exist, it will be created with the metadata fields. If
the _jc_meta field already exists, the metadata fields will be added to the _jc_meta field already exists, the metadata fields will be added to
the existing object. the existing object.
@ -625,7 +629,7 @@ class JcCli():
else: else:
utils.error_message(['Parser returned an unsupported object type.']) utils.error_message(['Parser returned an unsupported object type.'])
self.jc_exit = self.JC_ERROR_EXIT self.jc_exit = self.JC_ERROR_EXIT
sys.exit(self.combined_exit_code()) self.compute_exit_code_and_quit()
def ctrlc(self, signum, frame): def ctrlc(self, signum, frame):
"""Exit with error on SIGINT""" """Exit with error on SIGINT"""
@ -717,9 +721,11 @@ class JcCli():
try: try:
if _parser_is_streaming(self.parser_module): if _parser_is_streaming(self.parser_module):
self.streaming_parse_and_print() self.streaming_parse_and_print()
self.compute_exit_code_and_quit()
else: else:
self.standard_parse_and_print() self.standard_parse_and_print()
self.compute_exit_code_and_quit()
except (ParseError, LibraryNotInstalled) as e: except (ParseError, LibraryNotInstalled) as e:
if self.debug: if self.debug:
@ -731,7 +737,7 @@ class JcCli():
f'For details use the -d or -dd option. Use "jc -h --{self.parser_name}" for help.' f'For details use the -d or -dd option. Use "jc -h --{self.parser_name}" for help.'
]) ])
self.jc_exit = self.JC_ERROR_EXIT self.jc_exit = self.JC_ERROR_EXIT
sys.exit(self.combined_exit_code()) self.compute_exit_code_and_quit()
except Exception: except Exception:
if self.debug: if self.debug:
@ -748,7 +754,7 @@ class JcCli():
f'For details use the -d or -dd option. Use "jc -h --{self.parser_name}" for help.' f'For details use the -d or -dd option. Use "jc -h --{self.parser_name}" for help.'
]) ])
self.jc_exit = self.JC_ERROR_EXIT self.jc_exit = self.JC_ERROR_EXIT
sys.exit(self.combined_exit_code()) self.compute_exit_code_and_quit()
def main(): def main():