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

formatting and docstring updates

Browse Source
This commit is contained in:
Kelly Brazil
2020-07-09 11:11:29 -07:00
parent 8c96d5cd20
commit 27b21b2faf
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
jc/cli.py
View File

@ -143,6 +143,8 @@ else:
def set_env_colors(): def set_env_colors():
""" """
Return a dictionary to be used in Pygments custom style class.
Grab custom colors from JC_COLORS environment variable. JC_COLORS env variable takes 4 comma Grab custom colors from JC_COLORS environment variable. JC_COLORS env variable takes 4 comma
separated string values and should be in the format of: separated string values and should be in the format of:
@ -188,7 +190,7 @@ def set_env_colors():
def piped_output(): def piped_output():
"""Returns False if stdout is a TTY. True if output is being piped to another program""" """Return False if stdout is a TTY. True if output is being piped to another program"""
if sys.stdout.isatty(): if sys.stdout.isatty():
return False return False
else: else:
@ -201,17 +203,17 @@ def ctrlc(signum, frame):
def parser_shortname(parser_argument): def parser_shortname(parser_argument):
"""Short name of the parser with dashes and no -- prefix""" """Return short name of the parser with dashes and no -- prefix"""
return parser_argument[2:] return parser_argument[2:]
def parser_argument(parser): def parser_argument(parser):
"""Short name of the parser with dashes and with -- prefix""" """Return short name of the parser with dashes and with -- prefix"""
return f'--{parser}' return f'--{parser}'
def parser_mod_shortname(parser): def parser_mod_shortname(parser):
"""Short name of the parser's module name (no -- prefix and dashes converted to underscores)""" """Return short name of the parser's module name (no -- prefix and dashes converted to underscores)"""
return parser.replace('--', '').replace('-', '_') return parser.replace('--', '').replace('-', '_')
@ -304,7 +306,7 @@ def helptext(message):
def json_out(data, pretty=False, mono=False, piped_out=False): def json_out(data, pretty=False, mono=False, piped_out=False):
"""Returns a JSON formatted string. String may include color codes or be pretty printed.""" """Return a JSON formatted string. String may include color codes or be pretty printed."""
if not mono and not piped_out: if not mono and not piped_out:
# set colors # set colors
class JcStyle(Style): class JcStyle(Style):
@ -323,7 +325,7 @@ def json_out(data, pretty=False, mono=False, piped_out=False):
def generate_magic_command(args): def generate_magic_command(args):
""" """
Returns a tuple with a boolean and a command, where the boolean signifies that Return a tuple with a boolean and a command, where the boolean signifies that
the command is valid, and the command is either a command string or None. the command is valid, and the command is either a command string or None.
""" """
@ -447,7 +449,6 @@ def main():
except Exception: except Exception:
if debug: if debug:
raise raise
else: else:
import jc.utils import jc.utils
jc.utils.error_message( jc.utils.error_message(