mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-07-02 06:56:12 +02:00
Clean up help screen, get rid of util.py (#1027)
* More refactoring of cli.py break up code from cli.py (now in jrnl.py) up into smaller functions get rid of export mode move --encrypt and --decrypt to commands.py clean up the help screen even more update flag name for import * reorganize code, move around lots of functions * clean up import statements * move run function out of cli and into jrnl * rename confusingly named function * move editor function into editor file * rename parse_args.py to args.py to make room for more args functions * Fix error in test suite for windows I accidentally flipped the conditional, so this fixes it. Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com> * Update app description on help screen Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com>
This commit is contained in:
Jonathan Wren
GitHub
parent
7c3abb2625
commit
631e08a557
30 changed files with 981 additions and 775 deletions
289
jrnl/args.py
Normal file
289
jrnl/args.py
Normal file
|
|
@ -0,0 +1,289 @@
|
|||
import argparse
|
||||
import re
|
||||
import textwrap
|
||||
|
||||
from .commands import postconfig_decrypt
|
||||
from .commands import postconfig_encrypt
|
||||
from .commands import postconfig_import
|
||||
from .commands import postconfig_list
|
||||
from .commands import preconfig_diagnostic
|
||||
from .commands import preconfig_version
|
||||
from .output import deprecated_cmd
|
||||
from .plugins import EXPORT_FORMATS
|
||||
from .plugins import IMPORT_FORMATS
|
||||
from .plugins import util
|
||||
|
||||
|
||||
class WrappingFormatter(argparse.RawTextHelpFormatter):
|
||||
"""Used in help screen"""
|
||||
|
||||
def _split_lines(self, text, width):
|
||||
text = text.split("\n\n")
|
||||
text = map(lambda t: self._whitespace_matcher.sub(" ", t).strip(), text)
|
||||
text = map(lambda t: textwrap.wrap(t, width=56), text)
|
||||
text = [item for sublist in text for item in sublist]
|
||||
return text
|
||||
|
||||
|
||||
def parse_args(args=[]):
|
||||
"""
|
||||
Argument parsing that is doable before the config is available.
|
||||
Everything else goes into "text" for later parsing.
|
||||
"""
|
||||
parser = argparse.ArgumentParser(
|
||||
formatter_class=WrappingFormatter,
|
||||
add_help=False,
|
||||
description="Collect your thoughts and notes without leaving the command line",
|
||||
epilog=textwrap.dedent(
|
||||
"""
|
||||
Thank you to all of our contributors! Come see the whole list of code and
|
||||
financial contributors at https://github.com/jrnl-org/jrnl. And special
|
||||
thanks to Bad Lip Reading for the Yoda joke in the Writing section above."""
|
||||
),
|
||||
)
|
||||
|
||||
optional = parser.add_argument_group("Optional Arguments")
|
||||
optional.add_argument(
|
||||
"--debug",
|
||||
dest="debug",
|
||||
action="store_true",
|
||||
help="Print information useful for troubleshooting",
|
||||
)
|
||||
|
||||
standalone = parser.add_argument_group(
|
||||
"Standalone Commands",
|
||||
"These commands will exit after they complete. You may only run one at a time.",
|
||||
)
|
||||
standalone.add_argument("--help", action="help", help="Show this help message")
|
||||
standalone.add_argument("-h", action="help", help=argparse.SUPPRESS)
|
||||
standalone.add_argument(
|
||||
"--version",
|
||||
action="store_const",
|
||||
const=preconfig_version,
|
||||
dest="preconfig_cmd",
|
||||
help="Print version information",
|
||||
)
|
||||
standalone.add_argument(
|
||||
"-v",
|
||||
action="store_const",
|
||||
const=preconfig_version,
|
||||
dest="preconfig_cmd",
|
||||
help=argparse.SUPPRESS,
|
||||
)
|
||||
standalone.add_argument(
|
||||
"--diagnostic",
|
||||
action="store_const",
|
||||
const=preconfig_diagnostic,
|
||||
dest="preconfig_cmd",
|
||||
help=argparse.SUPPRESS,
|
||||
)
|
||||
standalone.add_argument(
|
||||
"--list",
|
||||
action="store_const",
|
||||
const=postconfig_list,
|
||||
dest="postconfig_cmd",
|
||||
help="List all configured journals",
|
||||
)
|
||||
standalone.add_argument(
|
||||
"--ls",
|
||||
action="store_const",
|
||||
const=postconfig_list,
|
||||
dest="postconfig_cmd",
|
||||
help=argparse.SUPPRESS,
|
||||
)
|
||||
standalone.add_argument(
|
||||
"-ls",
|
||||
action="store_const",
|
||||
const=lambda **kwargs: deprecated_cmd(
|
||||
"-ls", "--list or --ls", callback=postconfig_list, **kwargs
|
||||
),
|
||||
dest="postconfig_cmd",
|
||||
help=argparse.SUPPRESS,
|
||||
)
|
||||
standalone.add_argument(
|
||||
"--encrypt",
|
||||
help="Encrypt selected journal with a password",
|
||||
action="store_const",
|
||||
metavar="TYPE",
|
||||
const=postconfig_encrypt,
|
||||
dest="postconfig_cmd",
|
||||
)
|
||||
standalone.add_argument(
|
||||
"--decrypt",
|
||||
help="Decrypt selected journal and store it in plain text",
|
||||
action="store_const",
|
||||
metavar="TYPE",
|
||||
const=postconfig_decrypt,
|
||||
dest="postconfig_cmd",
|
||||
)
|
||||
standalone.add_argument(
|
||||
"--import",
|
||||
action="store_const",
|
||||
metavar="TYPE",
|
||||
const=postconfig_import,
|
||||
dest="postconfig_cmd",
|
||||
help=f"""
|
||||
Import entries from another journal.
|
||||
|
||||
Optional parameters:
|
||||
|
||||
--file FILENAME (default: uses stdin)
|
||||
|
||||
--format [{util.oxford_list(IMPORT_FORMATS)}] (default: jrnl)
|
||||
""",
|
||||
)
|
||||
standalone.add_argument(
|
||||
"--file",
|
||||
metavar="FILENAME",
|
||||
dest="filename",
|
||||
help=argparse.SUPPRESS,
|
||||
default=None,
|
||||
)
|
||||
standalone.add_argument("-i", dest="filename", help=argparse.SUPPRESS)
|
||||
|
||||
compose_msg = """
|
||||
To add a new entry into your journal, simply write it on the command line:
|
||||
|
||||
jrnl yesterday: I was walking and I found this big log.
|
||||
|
||||
The date and the following colon ("yesterday:") are optional. If you leave
|
||||
them out, "now" will be used:
|
||||
|
||||
jrnl Then I rolled the log over.
|
||||
|
||||
Also, you can mark extra special entries ("star" them) with an asterisk:
|
||||
|
||||
jrnl *And underneath was a tiny little stick.
|
||||
|
||||
Please note that asterisks might be a special character in your shell, so you
|
||||
might have to escape them. When in doubt about escaping, put quotes around
|
||||
your entire entry:
|
||||
|
||||
jrnl "saturday at 2am: *Then I was like 'That log had a child!'" """
|
||||
|
||||
composing = parser.add_argument_group(
|
||||
"Writing", textwrap.dedent(compose_msg).strip()
|
||||
)
|
||||
composing.add_argument("text", metavar="", nargs="*")
|
||||
|
||||
read_msg = (
|
||||
"To find entries from your journal, use any combination of the below filters."
|
||||
)
|
||||
reading = parser.add_argument_group("Searching", textwrap.dedent(read_msg))
|
||||
reading.add_argument(
|
||||
"-on", dest="on_date", metavar="DATE", help="Show entries on this date"
|
||||
)
|
||||
reading.add_argument(
|
||||
"-from",
|
||||
dest="start_date",
|
||||
metavar="DATE",
|
||||
help="Show entries after, or on, this date",
|
||||
)
|
||||
reading.add_argument(
|
||||
"-to",
|
||||
dest="end_date",
|
||||
metavar="DATE",
|
||||
help="Show entries before, or on, this date (alias: -until)",
|
||||
)
|
||||
reading.add_argument("-until", dest="end_date", help=argparse.SUPPRESS)
|
||||
reading.add_argument(
|
||||
"-contains",
|
||||
dest="contains",
|
||||
metavar="TEXT",
|
||||
help="Show entries containing specific text (put quotes around text with spaces)",
|
||||
)
|
||||
reading.add_argument(
|
||||
"-and",
|
||||
dest="strict",
|
||||
action="store_true",
|
||||
help='Show only entries that match all conditions, like saying "x AND y" (default: OR)',
|
||||
)
|
||||
reading.add_argument(
|
||||
"-starred",
|
||||
dest="starred",
|
||||
action="store_true",
|
||||
help="Show only starred entries (marked with *)",
|
||||
)
|
||||
reading.add_argument(
|
||||
"-n",
|
||||
dest="limit",
|
||||
default=None,
|
||||
metavar="NUMBER",
|
||||
help="Show a maximum of NUMBER entries (note: '-n 3' and '-3' have the same effect)",
|
||||
nargs="?",
|
||||
type=int,
|
||||
)
|
||||
reading.add_argument(
|
||||
"-not",
|
||||
dest="excluded",
|
||||
nargs="?",
|
||||
default=[],
|
||||
metavar="TAG",
|
||||
action="append",
|
||||
help="Exclude entries with this tag",
|
||||
)
|
||||
|
||||
search_options_msg = """ These help you do various tasks with the selected entries from your search.
|
||||
If used on their own (with no search), they will act on your entire journal"""
|
||||
exporting = parser.add_argument_group(
|
||||
"Searching Options", textwrap.dedent(search_options_msg)
|
||||
)
|
||||
exporting.add_argument(
|
||||
"--edit",
|
||||
dest="edit",
|
||||
help="Opens the selected entries in your configured editor",
|
||||
action="store_true",
|
||||
)
|
||||
exporting.add_argument(
|
||||
"--delete",
|
||||
dest="delete",
|
||||
action="store_true",
|
||||
help="Interactively deletes selected entries",
|
||||
)
|
||||
exporting.add_argument(
|
||||
"--format",
|
||||
metavar="TYPE",
|
||||
dest="export",
|
||||
choices=EXPORT_FORMATS,
|
||||
help=f"""
|
||||
Display selected entries in an alternate format.
|
||||
|
||||
TYPE can be: {util.oxford_list(EXPORT_FORMATS)}.
|
||||
|
||||
Optional parameters:
|
||||
|
||||
--file FILENAME Write output to file instead of stdout
|
||||
""",
|
||||
default=False,
|
||||
)
|
||||
exporting.add_argument(
|
||||
"--export",
|
||||
metavar="TYPE",
|
||||
dest="export",
|
||||
choices=EXPORT_FORMATS,
|
||||
help=argparse.SUPPRESS,
|
||||
)
|
||||
exporting.add_argument(
|
||||
"--tags",
|
||||
dest="tags",
|
||||
action="store_true",
|
||||
help="Alias for '--format tags'. Returns a list of all tags and number of occurences",
|
||||
)
|
||||
exporting.add_argument(
|
||||
"--short",
|
||||
dest="short",
|
||||
action="store_true",
|
||||
help="Show only titles or line containing the search tags",
|
||||
)
|
||||
exporting.add_argument(
|
||||
"-s", dest="short", action="store_true", help=argparse.SUPPRESS,
|
||||
)
|
||||
exporting.add_argument(
|
||||
"-o", dest="filename", help=argparse.SUPPRESS,
|
||||
)
|
||||
|
||||
# Handle '-123' as a shortcut for '-n 123'
|
||||
num = re.compile(r"^-(\d+)$")
|
||||
args = [num.sub(r"-n \1", arg) for arg in args]
|
||||
|
||||
return parser.parse_intermixed_args(args)
|
||||
Loading…
Add table
Add a link
Reference in a new issue