Add help= for aliases

Help=

Author: python-mario-bot

README.rst

@@ -376,7 +376,7 @@ Define new commands in your config file which provide aliases to other commands.
    [[alias]]
 
    name = "jsonl"
-   short_help = "Load jsonlines into python objects."
+   help = "Load jsonlines into python objects."
 
    [[alias.stage]]
 
@@ -419,7 +419,7 @@ Convenient for removing trailing commas.
     [[alias]]
 
         name = "yml2json"
-        short_help = "Convert yaml to json"
+        help = "Convert yaml to json"
 
         [[alias.stage]]
 
@@ -455,7 +455,7 @@ Pull text out of xml documents.
 
     [[alias]]
         name="xpath"
-        short_help = "Find xml elements matching xpath query."
+        help = "Find xml elements matching xpath query."
         arguments = [{name="query", type="str"}]
         inject_values=["query"]
 
@@ -482,7 +482,7 @@ Generate json objects
 
 
         name="jo"
-        short_help="Make json objects"
+        help="Make json objects"
         arguments=[{name="pairs", type="str"}]
         inject_values=["pairs"]
 
@@ -535,25 +535,57 @@ try:
 
 .. code-block:: toml
 
+    base_exec_before = '''
+    import csv
+    import typing as t
+
+
+    def read_csv(
+        file, header: bool, **kwargs
+    ) -> t.Iterable[t.Dict[t.Union[str, int], str]]:
+        "Read csv rows into an iterable of dicts."
+
+        rows = list(file)
+
+        first_row = next(csv.reader(rows))
+        if header:
+            fieldnames = first_row
+            reader = csv.DictReader(rows, fieldnames=fieldnames, **kwargs)
+            return list(reader)[1:]
+
+        fieldnames = range(len(first_row))
+        return csv.DictReader(rows, fieldnames=fieldnames, **kwargs)
+
+    '''
+
+
+
+
     [[alias]]
         name = "csv"
-        short_help = "Load csv rows into python objects"
-        inject_values=["delimiter"]
+        help = "Load csv rows into python dicts. With --no-header, keys will be numbered from 0."
+        inject_values=["delimiter", "header"]
 
         [[alias.options]]
         name = "--delimiter"
         default = ","
+        help = "field delimiter character"
+
+        [[alias.options]]
+        name = "--header/--no-header"
+        default=true
+        help = "Treat the first row as a header?"
 
         [[alias.stage]]
         command = "apply"
-        options = {code="csv.DictReader(x, delimiter=delimiter)"}
+        options = {code="read_csv(x, header=header)"}
 
         [[alias.stage]]
         command = "chain"
 
         [[alias.stage]]
         command = "map"
-        options = {code="dict"}
+        options = {code="dict(x)"}
 
 
 

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.112
+current_version = 0.0.114
 commit = True
 tag = True
 

setup.py

@@ -13,7 +13,7 @@
 
 setuptools.setup(
     name="mario",
-    version="0.0.112",
+    version="0.0.114",
     description="Shell pipes for Python.",
     long_description=open(PROJECT_ROOT / "README.rst").read(),
     long_description_content_type="text/x-rst",

src/mario/_version.py

@@ -1 +1 @@
-__version__ = "0.0.112"
+__version__ = "0.0.114"

src/mario/aliasing.py

@@ -101,7 +101,8 @@ def make(self, validated, partial, many):
 @attr.dataclass
 class Alias:
     name: str
-    short_help: str
+    short_help: t.Optional[str]
+    help: t.Optional[str]
     arguments: t.List[click.Argument]
     options: t.List[click.Option]
     stages: t.List[AliasStage]
@@ -110,7 +111,8 @@ class Alias:
 
 class AliasSchema(marshmallow.Schema):
     name = fields.String()
-    short_help = fields.String(default=None)
+    help = fields.String(default=None, missing=None)
+    short_help = fields.String(default=None, missing=None)
     arguments = fields.List(fields.Nested(ArgumentSchema), missing=list)
     options = fields.List(fields.Nested(OptionSchema), missing=list)
     stages = fields.List(fields.Nested(AliasStageSchema), data_key="stage")

src/mario/cli.py

@@ -80,7 +80,11 @@ def run(ctx, **cli_params):
 
     params = alias.arguments + alias.options
     return click.Command(
-        name=alias.name, params=params, callback=click.pass_context(run)
+        name=alias.name,
+        params=params,
+        callback=click.pass_context(run),
+        short_help=alias.short_help,
+        help=alias.help,
     )