mirror of
https://github.com/cheat/cheat.git
synced 2024-12-22 20:55:06 +01:00
Made a OO refactoring, cleaner in my mind
This commit is contained in:
parent
1e1520ce56
commit
c87e741f34
203
cheat
203
cheat
@ -40,76 +40,6 @@ if os.name == 'posix' and 'CHEATCOLORS' in os.environ:
|
|||||||
except ImportError:
|
except ImportError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def cheat_directories():
|
|
||||||
"Assembles a list of directories containing cheatsheets."
|
|
||||||
default_directories = [DEFAULT_CHEAT_DIR]
|
|
||||||
try:
|
|
||||||
import cheatsheets
|
|
||||||
default_directories.append(cheatsheets.cheat_dir)
|
|
||||||
except ImportError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
default = [default_dir for default_dir in default_directories
|
|
||||||
if os.path.isdir(default_dir)]
|
|
||||||
|
|
||||||
if 'CHEATPATH' in os.environ and os.environ['CHEATPATH']:
|
|
||||||
return [path for path in os.environ['CHEATPATH'].split(os.pathsep)
|
|
||||||
if os.path.isdir(path)] + default
|
|
||||||
else:
|
|
||||||
return default
|
|
||||||
|
|
||||||
|
|
||||||
def cheat_files(cheat_directories):
|
|
||||||
"Assembles a dictionary of cheatsheets found in the above directories."
|
|
||||||
cheats = {}
|
|
||||||
for cheat_dir in reversed(cheat_directories):
|
|
||||||
cheats.update(dict([(cheat, cheat_dir)
|
|
||||||
for cheat in os.listdir(cheat_dir)
|
|
||||||
if not cheat.startswith('.')
|
|
||||||
and not cheat.startswith('__')]))
|
|
||||||
return cheats
|
|
||||||
|
|
||||||
|
|
||||||
def edit_cheatsheet(cheat, cheatsheets):
|
|
||||||
"Creates or edits a cheatsheet"
|
|
||||||
|
|
||||||
# Assert that the EDITOR environment variable is set and that at least 3
|
|
||||||
# arguments have been given
|
|
||||||
if 'EDITOR' not in os.environ:
|
|
||||||
print('In order to use "create" or "edit" you must set your '
|
|
||||||
'EDITOR environment variable to your favorite editor\'s path')
|
|
||||||
exit()
|
|
||||||
|
|
||||||
elif len(sys.argv) < 3:
|
|
||||||
print('Must provide a cheatsheet to edit/create')
|
|
||||||
exit()
|
|
||||||
|
|
||||||
# if the cheatsheet already exists, open it for editing
|
|
||||||
if cheat in cheatsheets:
|
|
||||||
subprocess.call([os.environ['EDITOR'],
|
|
||||||
os.path.join(cheatsheets[cheat], cheat)])
|
|
||||||
|
|
||||||
# otherwise, create it
|
|
||||||
else:
|
|
||||||
import cheatsheets as cs
|
|
||||||
# Attempt to write the new cheatsheet to the user's ~/.cheat dir if it
|
|
||||||
# exists. If it does not exist, attempt to create it.
|
|
||||||
if os.access(DEFAULT_CHEAT_DIR, os.W_OK) or os.makedirs(DEFAULT_CHEAT_DIR):
|
|
||||||
subprocess.call([os.environ['EDITOR'],
|
|
||||||
os.path.join(DEFAULT_CHEAT_DIR, cheat)])
|
|
||||||
|
|
||||||
# If the directory cannot be created, write to the python package
|
|
||||||
# directory, though that will likely require the use of sudo
|
|
||||||
else:
|
|
||||||
subprocess.call([os.environ['EDITOR'],
|
|
||||||
os.path.join(cs.cheat_dir, cheat)])
|
|
||||||
|
|
||||||
def list_cheatsheets(cheatsheets):
|
|
||||||
"Lists the cheatsheets that are currently available"
|
|
||||||
max_command = max([len(x) for x in cheatsheets.keys()]) + 3
|
|
||||||
return ('\n'.join(sorted(['%s [%s]' % (key.ljust(max_command), value)
|
|
||||||
for key, value in cheatsheets.items()])))
|
|
||||||
|
|
||||||
def pretty_print(filename):
|
def pretty_print(filename):
|
||||||
"Applies syntax highlighting to a cheatsheet and writes it to stdout"
|
"Applies syntax highlighting to a cheatsheet and writes it to stdout"
|
||||||
try:
|
try:
|
||||||
@ -128,55 +58,109 @@ def pretty_print(filename):
|
|||||||
fmt = TerminalFormatter()
|
fmt = TerminalFormatter()
|
||||||
highlight(code, lexer, fmt, sys.stdout)
|
highlight(code, lexer, fmt, sys.stdout)
|
||||||
|
|
||||||
def main():
|
class CheatSheets(object):
|
||||||
cheat_dirs = cheat_directories()
|
|
||||||
|
|
||||||
|
dirs = None
|
||||||
|
sheets = None
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.dirs = self.__cheat_directories()
|
||||||
# verify that we have at least one cheat directory
|
# verify that we have at least one cheat directory
|
||||||
if not cheat_dirs:
|
if not self.dirs:
|
||||||
error_msg = 'The {default} dir does not exist or the CHEATPATH var is not set.'
|
error_msg = 'The {default} dir does not exist or the CHEATPATH var is not set.'
|
||||||
print >> sys.stderr, error_msg.format(default=DEFAULT_CHEAT_DIR)
|
print >> sys.stderr, error_msg.format(default=DEFAULT_CHEAT_DIR)
|
||||||
exit()
|
exit()
|
||||||
|
self.sheets = self.__cheat_files()
|
||||||
|
|
||||||
# list the files in the ~/.cheat directory
|
def __cheat_directories(self):
|
||||||
cheatsheets = cheat_files(cheat_dirs)
|
"""Assembles a list of directories containing cheatsheets."""
|
||||||
|
default_directories = [DEFAULT_CHEAT_DIR]
|
||||||
|
try:
|
||||||
|
import cheatsheets
|
||||||
|
default_directories.append(cheatsheets.cheat_dir)
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
default = [default_dir for default_dir in default_directories
|
||||||
|
if os.path.isdir(default_dir)]
|
||||||
|
|
||||||
|
if 'CHEATPATH' in os.environ and os.environ['CHEATPATH']:
|
||||||
|
return [path for path in os.environ['CHEATPATH'].split(os.pathsep)
|
||||||
|
if os.path.isdir(path)] + default
|
||||||
|
else:
|
||||||
|
return default
|
||||||
|
|
||||||
|
def __cheat_files(self):
|
||||||
|
"""Assembles a dictionary of cheatsheets found in the above directories."""
|
||||||
|
cheats = {}
|
||||||
|
for cheat_dir in reversed(self.dirs):
|
||||||
|
cheats.update(dict([(cheat, cheat_dir)
|
||||||
|
for cheat in os.listdir(cheat_dir)
|
||||||
|
if not cheat.startswith('.')
|
||||||
|
and not cheat.startswith('__')]))
|
||||||
|
return cheats
|
||||||
|
|
||||||
|
def edit(self, cheat):
|
||||||
|
"""Creates or edits a cheatsheet"""
|
||||||
|
|
||||||
|
# Assert that the EDITOR environment variable is set and that at least 3
|
||||||
|
# arguments have been given
|
||||||
|
if 'EDITOR' not in os.environ:
|
||||||
|
print('In order to use "create" or "edit" you must set your '
|
||||||
|
'EDITOR environment variable to your favorite editor\'s path')
|
||||||
|
exit()
|
||||||
|
|
||||||
|
# if the cheatsheet already exists, open it for editing
|
||||||
|
if cheat in sheets.sheets:
|
||||||
|
subprocess.call([os.environ['EDITOR'],
|
||||||
|
os.path.join(self.sheets[cheat], cheat)])
|
||||||
|
|
||||||
|
# otherwise, create it
|
||||||
|
else:
|
||||||
|
import cheatsheets as cs
|
||||||
|
# Attempt to write the new cheatsheet to the user's ~/.cheat dir if it
|
||||||
|
# exists. If it does not exist, attempt to create it.
|
||||||
|
if os.access(DEFAULT_CHEAT_DIR, os.W_OK) or os.makedirs(DEFAULT_CHEAT_DIR):
|
||||||
|
subprocess.call([os.environ['EDITOR'],
|
||||||
|
os.path.join(DEFAULT_CHEAT_DIR, cheat)])
|
||||||
|
|
||||||
|
# If the directory cannot be created, write to the python package
|
||||||
|
# directory, though that will likely require the use of sudo
|
||||||
|
else:
|
||||||
|
subprocess.call([os.environ['EDITOR'],
|
||||||
|
os.path.join(cs.cheat_dir, cheat)])
|
||||||
|
|
||||||
|
def list(self):
|
||||||
|
"""Lists the cheatsheets that are currently available"""
|
||||||
|
max_command = max([len(x) for x in self.sheets.keys()]) + 3
|
||||||
|
return ('\n'.join(sorted(['%s [%s]' % (key.ljust(max_command), value)
|
||||||
|
for key, value in self.sheets.items()])))
|
||||||
|
|
||||||
|
# Custom action for argparse
|
||||||
|
|
||||||
# list cheat directories and exit
|
|
||||||
class ListDirectories(argparse.Action):
|
class ListDirectories(argparse.Action):
|
||||||
|
"""List cheat directories and exit"""
|
||||||
def __call__(self, parser, namespace, values, option_string=None):
|
def __call__(self, parser, namespace, values, option_string=None):
|
||||||
print cheat_directories()
|
print sheets.dirs
|
||||||
parser.exit()
|
parser.exit()
|
||||||
|
|
||||||
# list cheatsheets and exit
|
|
||||||
class ListCheatsheets(argparse.Action):
|
class ListCheatsheets(argparse.Action):
|
||||||
|
"""List cheatsheets and exit"""
|
||||||
def __call__(self, parser, namespace, values, option_string=None):
|
def __call__(self, parser, namespace, values, option_string=None):
|
||||||
print list_cheatsheets(cheatsheets)
|
print sheets.list()
|
||||||
parser.exit()
|
parser.exit()
|
||||||
|
|
||||||
# if the user wants to edit a cheatsheet
|
|
||||||
class EditSheet(argparse.Action):
|
class EditSheet(argparse.Action):
|
||||||
|
"""If the user wants to edit a cheatsheet"""
|
||||||
def __call__(self, parser, namespace, values, option_string=None):
|
def __call__(self, parser, namespace, values, option_string=None):
|
||||||
edit_cheatsheet(values[0], cheatsheets)
|
sheets.edit(values[0])
|
||||||
parser.exit()
|
parser.exit()
|
||||||
|
|
||||||
# print the cheatsheet if it exists
|
def main():
|
||||||
class PrintSheet(argparse.Action):
|
|
||||||
def __call__(self, parser, namespace, value, option_string=None):
|
|
||||||
if not value or value in ['help', 'cheat']:
|
|
||||||
parser.print_help()
|
|
||||||
elif value in cheatsheets:
|
|
||||||
filename = os.path.join(cheatsheets[value], value)
|
|
||||||
if USE_PYGMENTS:
|
|
||||||
pretty_print(filename)
|
|
||||||
else:
|
|
||||||
with open(filename) as istream:
|
|
||||||
for l in istream:
|
|
||||||
sys.stdout.write(l)
|
|
||||||
|
|
||||||
# if it does not, say so
|
global sheets
|
||||||
else:
|
sheets = CheatSheets()
|
||||||
print >> sys.stderr, ('No cheatsheet found for %s.' % value)
|
|
||||||
parser.exit(1)
|
|
||||||
parser.exit()
|
|
||||||
|
|
||||||
desc = dedent('''
|
desc = dedent('''
|
||||||
cheat allows you to create and view interactive cheatsheets on the
|
cheat allows you to create and view interactive cheatsheets on the
|
||||||
@ -205,7 +189,7 @@ def main():
|
|||||||
formatter_class=argparse.RawDescriptionHelpFormatter)
|
formatter_class=argparse.RawDescriptionHelpFormatter)
|
||||||
parser_group = parser.add_mutually_exclusive_group()
|
parser_group = parser.add_mutually_exclusive_group()
|
||||||
parser_group.add_argument('sheet', metavar='cheatsheet',
|
parser_group.add_argument('sheet', metavar='cheatsheet',
|
||||||
action=PrintSheet, type=str, nargs='?',
|
action='store', type=str, nargs='?',
|
||||||
help='Look at <cheatseet>')
|
help='Look at <cheatseet>')
|
||||||
parser_group.add_argument('-c', '--create', metavar='cheatsheet',
|
parser_group.add_argument('-c', '--create', metavar='cheatsheet',
|
||||||
action=EditSheet, type=str, nargs=1,
|
action=EditSheet, type=str, nargs=1,
|
||||||
@ -220,6 +204,25 @@ def main():
|
|||||||
action=ListDirectories, nargs=0,
|
action=ListDirectories, nargs=0,
|
||||||
help='List all current cheat dirs')
|
help='List all current cheat dirs')
|
||||||
args = parser.parse_args()
|
args = parser.parse_args()
|
||||||
|
sheet = args.sheet
|
||||||
|
|
||||||
|
# Print the cheatsheet if it exists
|
||||||
|
if not sheet or sheet in ['help', 'cheat']:
|
||||||
|
parser.print_help()
|
||||||
|
elif sheet in sheets.sheets:
|
||||||
|
filename = os.path.join(sheets.sheets[sheet], sheet)
|
||||||
|
if USE_PYGMENTS:
|
||||||
|
pretty_print(filename)
|
||||||
|
else:
|
||||||
|
with open(filename) as istream:
|
||||||
|
for l in istream:
|
||||||
|
sys.stdout.write(l)
|
||||||
|
|
||||||
|
# if it does not, say so
|
||||||
|
else:
|
||||||
|
print >> sys.stderr, ('No cheatsheet found for %s.' % sheet)
|
||||||
|
exit(1)
|
||||||
|
exit()
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
main()
|
main()
|
||||||
|
Loading…
Reference in New Issue
Block a user