singlestoredb 1.0.3__cp38-abi3-win_amd64.whl → 1.1.0__cp38-abi3-win_amd64.whl

singlestoredb/fusion/handler.py

@@ -45,6 +45,8 @@ BUILTINS = {
     '<limit>': r'''
     limit = LIMIT <integer>
     ''',
+    '<integer>': '',
+    '<number>': '',
 }
 
 BUILTIN_DEFAULTS = {  # type: ignore
@@ -170,8 +172,8 @@ def build_cmd(grammar: str) -> str:
     return f'{space}{cmd} ={begin}\n{end}'
 
 
-def build_help(grammar: str) -> str:
-    """Construct full help syntax."""
+def build_syntax(grammar: str) -> str:
+    """Construct full syntax."""
     if ';' not in grammar:
         raise ValueError('a semi-colon exist at the end of the primary rule')
 
@@ -199,8 +201,96 @@ def build_help(grammar: str) -> str:
     return cmd
 
 
+def _format_examples(ex: str) -> str:
+    """Convert examples into sections."""
+    return re.sub(r'(^Example\s+\d+.*$)', r'### \1', ex, flags=re.M)
+
+
+def _format_arguments(arg: str) -> str:
+    """Format arguments as subsections."""
+    out = []
+    for line in arg.split('\n'):
+        if line.startswith('<'):
+            out.append(f'### {line.replace("<", "&lt;").replace(">", "&gt;")}')
+            out.append('')
+        else:
+            out.append(line.strip())
+    return '\n'.join(out)
+
+
+def _to_markdown(txt: str) -> str:
+    """Convert formatting to markdown."""
+    txt = txt.replace('``', '`')
+
+    # Format code blocks
+    lines = re.split(r'\n', txt)
+    out = []
+    while lines:
+        line = lines.pop(0)
+        if line.endswith('::'):
+            out.append(line[:-2])
+            code = []
+            while lines and (not lines[0].strip() or lines[0].startswith(' ')):
+                code.append(lines.pop(0).rstrip())
+            out.extend(['```sql', '\n'.join(code).rstrip(), '```\n'])
+        else:
+            out.append(line)
+
+    return '\n'.join(out)
+
+
+def build_help(syntax: str, grammar: str) -> str:
+    """Build full help text."""
+    syntax = re.sub(r'\s*\n+\s*', r' ', syntax.strip())
+
+    cmd = re.match(r'([A-Z0-9_ ]+)', syntax)
+    if not cmd:
+        raise ValueError(f'no command found: {syntax}')
+
+    out = [f'# {cmd.group(1)}\n\n']
+
+    sections: Dict[str, str] = {}
+    grammar = textwrap.dedent(grammar.rstrip())
+    desc_re = re.compile(r'^([A-Z][\S ]+)\s*^\-\-\-\-+\s*$', flags=re.M)
+    if desc_re.search(grammar):
+        _, *txt = desc_re.split(grammar)
+        txt = [x.strip() for x in txt]
+        sections = {}
+        while txt:
+            key = txt.pop(0)
+            value = txt.pop(0)
+            sections[key.lower()] = _to_markdown(value).strip()
+
+    if 'description' in sections:
+        out.extend([sections['description'], '\n\n'])
+
+    out.extend(['## Syntax\n```sql\n', syntax, '\n```\n\n'])
+
+    if 'arguments' in sections:
+        out.extend([
+            '## Arguments\n\n',
+            _format_arguments(sections['arguments']),
+            '\n\n',
+        ])
+
+    if 'remarks' in sections:
+        out.extend(['## Remarks\n', sections['remarks'], '\n\n'])
+
+    if 'examples' in sections:
+        out.extend(['## Examples\n\n', _format_examples(sections['examples']), '\n\n'])
+    elif 'example' in sections:
+        out.extend(['## Example\n\n', _format_examples(sections['example']), '\n\n'])
+
+    if 'see also' in sections:
+        out.extend(['## See Also\n', sections['see also'], '\n\n'])
+
+    return ''.join(out).rstrip() + '\n'
+
+
 def strip_comments(grammar: str) -> str:
     """Strip comments from grammar."""
+    desc_re = re.compile(r'(^\s*Description\s*^\s*-----------\s*$)', flags=re.M)
+    grammar = desc_re.split(grammar, maxsplit=1)[0]
     return re.sub(r'^\s*#.*$', r'', grammar, flags=re.M)
 
 
@@ -226,7 +316,9 @@ def inject_builtins(grammar: str) -> str:
     return grammar
 
 
-def process_grammar(grammar: str) -> Tuple[Grammar, Tuple[str, ...], Dict[str, Any], str]:
+def process_grammar(
+    grammar: str,
+) -> Tuple[Grammar, Tuple[str, ...], Dict[str, Any], str, str]:
     """
     Convert SQL grammar to a Parsimonious grammar.
 
@@ -247,10 +339,12 @@ def process_grammar(grammar: str) -> Tuple[Grammar, Tuple[str, ...], Dict[str, A
     rules = {}
     rule_info = {}
 
+    full_grammar = grammar
     grammar = strip_comments(grammar)
     grammar = inject_builtins(grammar)
     command_key = get_keywords(grammar)
-    help_txt = build_help(grammar)
+    syntax_txt = build_syntax(grammar)
+    help_txt = build_help(syntax_txt, full_grammar)
     grammar = build_cmd(grammar)
 
     # Make sure grouping characters all have whitespace around them
@@ -336,7 +430,10 @@ def process_grammar(grammar: str) -> Tuple[Grammar, Tuple[str, ...], Dict[str, A
     cmds = ' / '.join(x for x in rules if x.endswith('_cmd'))
     cmds = f'init = ws* ( {cmds} ) ws* ";"? ws*\n'
 
-    return Grammar(cmds + CORE_GRAMMAR + '\n'.join(out)), command_key, rule_info, help_txt
+    return (
+        Grammar(cmds + CORE_GRAMMAR + '\n'.join(out)), command_key,
+        rule_info, syntax_txt, help_txt,
+    )
 
 
 def flatten(items: Iterable[Any]) -> List[Any]:
@@ -378,7 +475,10 @@ class SQLHandler(NodeVisitor):
     #: Metadata about the parse rules
     rule_info: Dict[str, Any] = {}
 
-    #: Help string for use in error messages
+    #: Syntax string for use in error messages
+    syntax: str = ''
+
+    #: Full help for the command
     help: str = ''
 
     #: Rule validation functions
@@ -396,7 +496,7 @@ class SQLHandler(NodeVisitor):
         Compile the grammar held in the docstring.
 
         This method modifies attributes on the class: ``grammar``,
-        ``command_key``, ``rule_info``, and ``help``.
+        ``command_key``, ``rule_info``, ``syntax``, and ``help``.
 
         Parameters
         ----------
@@ -407,7 +507,7 @@ class SQLHandler(NodeVisitor):
         if cls._is_compiled:
             return
 
-        cls.grammar, cls.command_key, cls.rule_info, cls.help = \
+        cls.grammar, cls.command_key, cls.rule_info, cls.syntax, cls.help = \
             process_grammar(grammar or cls.__doc__ or '')
 
         cls._grammar = grammar or cls.__doc__ or ''
@@ -476,7 +576,7 @@ class SQLHandler(NodeVisitor):
                 msg = ' ' + m.group(1) + m.group(2)
             raise ValueError(
                 f'Could not parse statement.{msg} '
-                'Expecting:\n' + textwrap.indent(type(self).help, '  '),
+                'Expecting:\n' + textwrap.indent(type(self).syntax, '  '),
             )
 
     @abc.abstractmethod

singlestoredb/fusion/handlers/stage.py

@@ -33,6 +33,41 @@ class ShowStageFilesHandler(SQLHandler):
     # Should extended attributes be shown?
     extended = EXTENDED
 
+    Description
+    -----------
+    Show the files in a workspace group's stage.
+
+    Remarks
+    -------
+    * ``IN GROUP`` specifies the workspace group or workspace group ID.
+      When using an ID, ``IN GROUP ID`` must be used.
+    * ``AT PATH`` specifies the path to list. If no ``AT PATH`` is specified,
+      the root directory is used.
+    * ``LIKE`` allows you to specify a filename pattern using ``%`` as a wildcard.
+    * ``ORDER BY`` allows you to specify the field to sort by.
+    * ``LIMIT`` allows you to set a limit on the number of entries displayed.
+    * ``RECURSIVE`` indicates that the stage should be listed recursively.
+    * ``EXTENDED`` indicates that more detailed information should be displayed.
+
+    Examples
+    --------
+    Example 1: Show files at path
+
+    This example shows how to list files starting at a specific path::
+
+        SHOW STAGE FILES IN GROUP "My Group" AT PATH "/data/";
+
+    Example 2: Show files recursively
+
+    This example show dow to display files recursively and with extra information::
+
+        SHOW STAGE FILES IN GROUP "My Group" RECURSIVE EXTENDED;
+
+    See Also
+    --------
+    * UPLOAD FILE TO STAGE
+    * DOWNLOAD STAGE FILE
+
     """
 
     def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
@@ -100,6 +135,30 @@ class UploadStageFileHandler(SQLHandler):
     # Should an existing file be overwritten?
     overwrite = OVERWRITE
 
+    Description
+    -----------
+    Upload a file to the workspace group's stage.
+
+    Remarks
+    -------
+    * ``<stage-path>`` is the path in stage to upload the file to.
+    * ``IN GROUP`` specifies the workspace group or workspace group ID. When
+      using an ID ``IN GROUP ID`` should be used.
+    * ``<local-path>`` is the path on the local machine of the file to upload.
+    * ``OVERWRITE`` indicates that an existing stage file at that path
+      should be overwritten if it exists.
+
+    Examples
+    --------
+    Example 1: Upload with overwrite::
+
+        UPLOAD FILE TO STAGE '/data/stats.csv' IN GROUP 'My Group'
+               FROM '/u/user/stats.csv' OVERWRITE;
+
+    See Also
+    --------
+    * DOWNLOAD STAGE FILE
+
     """
 
     def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
@@ -140,6 +199,38 @@ class DownloadStageFileHandler(SQLHandler):
     # File encoding
     encoding = ENCODING '<encoding>'
 
+    Description
+    -----------
+    Download a stage file.
+
+    Remarks
+    -------
+    * ``<stage-path>`` is the path in stage to download.
+    * ``IN GROUP`` specifies the workspace group or workspace group ID. When
+      using an ID ``IN GROUP ID`` should be used.
+    * ``<local-path>`` is the destination path for the file. If not specified,
+      the file is returned in a result set.
+    * ``OVERWRITE`` indicates that an existing local file should be overwritten.
+    * ``ENCODING`` specifies the encoding of the file to apply to the downloaded
+      file. By default, files are downloaded as binary. This only option
+      typically only matters if ``<local-path>`` is not specified and the file
+      is to be printed to the screen.
+
+    Examples
+    --------
+    Example 1: Print a file to the screen::
+
+        DOWNLOAD STAGE FILE '/data/stats.csv' IN GROUP 'My Group';
+
+    Example 2: Download a file to a local path with overwrite set::
+
+        DONLOAD STAGE FILE '/data/stats.csv' IN GROUP 'My Group'
+                TO '/u/me/data.csv' OVERWRITE;
+
+    See Also
+    --------
+    * UPLOAD FILE TO STAGE
+
     """
 
     def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
@@ -183,6 +274,26 @@ class DropStageFileHandler(SQLHandler):
     # Name of group
     group_name = '<group-name>'
 
+    Description
+    -----------
+    Drop a stage file.
+
+    Remarks
+    -------
+    * ``<stage-path>`` is the path in stage to drop.
+    * ``IN GROUP`` specifies the workspace group or workspace group ID. When
+      using an ID ``IN GROUP ID`` should be used.
+
+    Example
+    --------
+    Drop a specific file from stage::
+
+        DROP STAGE FILE '/data/stats.csv' IN GROUP 'My Group';
+
+    See Also
+    --------
+    * DROP STAGE FOLDER
+
     """
 
     def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
@@ -213,6 +324,27 @@ class DropStageFolderHandler(SQLHandler):
     # Should folers be deleted recursively?
     recursive = RECURSIVE
 
+    Description
+    -----------
+    Drop a folder from stage.
+
+    Remarks
+    -------
+    * ``<stage-path>`` is the path in stage to drop.
+    * ``IN GROUP`` specifies the workspace group or workspace group ID. When
+      using an ID ``IN GROUP ID`` should be used.
+    * ``RECURSIVE`` indicates that folders should be removed recursively.
+
+    Example
+    -------
+    Drop a folder recursively::
+
+        DROP STAGE FOLDER '/data/' IN GROUP 'My Group' RECURSIVE;
+
+    See Also
+    --------
+    * DROP STAGE FILE
+
     """
 
     def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
@@ -246,6 +378,24 @@ class CreateStageFolderHandler(SQLHandler):
     # Should an existing folder be overwritten?
     overwrite = OVERWRITE
 
+    Description
+    -----------
+    Create a folder in stage.
+
+    Remarks
+    -------
+    * ``<stage-path>`` is the path to create in stage.
+    * ``IN GROUP`` specifies the workspace group or workspace group ID. When
+      using an ID ``IN GROUP ID`` should be used.
+    * ``OVERWRITE`` indicates that an existing folder should be overwritten
+      with a new folder.
+
+    Example
+    -------
+    Create a folder::
+
+        CREATE STAGE FOLDER `/data/csv/` IN GROUP 'My Group';
+
     """
 
     def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]: