From b2d47d2ca978e2cd62be4cb6fe0471598427b8b7 Mon Sep 17 00:00:00 2001 From: zlg Date: Sat, 8 Sep 2018 19:15:48 -0700 Subject: cli: add '--raw' option to list command Add '--raw' option to the list command, in addition to proper note expansion. Newline characters in notes are escaped to be friendly to scripting. This option may be shortened to '-r' at the user's convenience. In raw output mode, the information is formatted in plain pipe-delimited strings, one line per row: title|system|ownership|progress|notes ownership and progress are printed in their numeric form, consistent with the OWNERSHIP and PROGRESS dictionaries in the vgstash package. An empty notes field will result in a line ending with a pipe and no whitespace following it. --- src/vgstash_cli.py | 40 +++++++++++++++++++++++++++++++++------- 1 file changed, 33 insertions(+), 7 deletions(-) (limited to 'src/vgstash_cli.py') diff --git a/src/vgstash_cli.py b/src/vgstash_cli.py index 9f5eef4..3d1d1db 100644 --- a/src/vgstash_cli.py +++ b/src/vgstash_cli.py @@ -4,9 +4,10 @@ import click import sys def get_db(): - """ - Convenience function to fetch a vgstash DB object from the default location. - """ + """Fetch a vgstash DB object from the default location. + + Change DEFAULT_CONFIG['db_location'] before calling this function + to alter behavior.""" return vgstash.DB(vgstash.DEFAULT_CONFIG['db_location']) @@ -24,6 +25,7 @@ def init(): else: raise sqlite3.OperationalError("Cannot create schema.") + @cli.command('add') @click.argument('title', type=str) @click.argument('system', type=str) @@ -49,16 +51,40 @@ def add(title, system, ownership, progress, notes): "have completed", ) note_clause = "" if len(game.notes) == 0 else " It also has notes." - click.echo("Added {} for {}. You {} it and {} it.{}".format(game.title, game.system, own_clause[game.ownership], progress_clause[game.progress], note_clause)) + click.echo("Added {} for {}. You {} it and {} it.{}".format( + game.title, + game.system, + own_clause[game.ownership], + progress_clause[game.progress], + note_clause, + )) except sqlite3.IntegrityError as e: print(e) click.echo("Couldn't add game.") @cli.command('list') -@click.argument('filter', required=False) -def list_games(filter="allgames"): +@click.argument('filter', required=False, default="allgames") +@click.option('--raw', '-r', is_flag=True, show_default=True, default=False, help="Output raw, pipe-delimited lines") +def list_games(filter, raw): db = get_db() res = db.list_games(filter) for r in res: - click.echo("{}|{}|{}|{}|{}".format(r['title'], r['system'], r['ownership'], r['progress'], r['notes'])) + if 'notes' in r.keys() and len(r['notes']) > 0: + notes = r['notes'].replace('\n', '\\n') + notes = notes.replace('\r', '\\r') + else: + notes = '' + + if raw: + click.echo("|".join(( + r['title'], + r['system'], + str(r['ownership']), + str(r['progress']), + notes + ) + )) + else: + pass + #pretty_print(r) -- cgit v1.2.3-70-g09d2 ad4b705166d8bd8cd9783c16856d07c470d3e0&follow=1'>cli: Add "notes" commandzlg2-4/+74 2018-10-09update_game: ensure notes are also savedzlg1-2/+2 2018-10-09cli: add 'update' commandzlg3-20/+92 2018-10-06cli: Add "delete" commandzlg2-0/+19 2018-10-06Remove ID field from DBzlg3-38/+46 2018-10-06cli: change "Status" heading to "Progress"zlg2-36/+40 2018-09-29Bump to 0.3alpha5 for PyPIzlg1-1/+1 2018-09-29cli: Add pretty printing to 'list' commandzlg3-17/+107 2018-09-08setup.py: Bump to alpha4 for PyPIzlg1-1/+1 2018-09-08cli: add '--raw' option to list commandzlg2-9/+45 2018-09-08Add remaining filters to vgstash packagezlg1-2/+11 2018-09-04Update LICENSE to match setup.pyzlg1-80/+67 2018-09-03Branch off from master with pytest, tox, clickzlg16-778/+779 2018-03-18Flesh out filter types and ownership statuszlg3-82/+144 2018-03-18README.mdown: break line correctlyzlg1-1/+1 2018-03-18add 'playlog' list filterzlg2-2/+9 2018-03-13Update helpers a bitzlg1-2/+9 2018-03-13Make VGSTASH_DB_LOCATION point to a filezlg2-21/+20 2016-11-18Remove settings from helpers.shZe Libertine Gamer1-5/+0 2016-11-15Correct phrasing in README.Ze Libertine Gamer1-4/+4 2016-11-13DerpZe Libertine Gamer1-0/+1 2016-11-03Improve error handling in shell scriptsZe Libertine Gamer4-3/+23 2016-10-24Correct run_again, add recursionZe Libertine Gamer1-0/+4 2016-10-21Add quotes to correct behavior for arglistZe Libertine Gamer1-1/+1 2016-10-14updater.sh: add recursion, error handlingZe Libertine Gamer1-43/+101 2016-10-14Correct pipe-handling behaviorZe Libertine Gamer1-1/+9 2016-10-12Clarify a method to move between platformsZe Libertine Gamer1-2/+5