NPO-Accounting/conservancy_beancount Changeset - ea10fb239f57

Changeset - ea10fb239f57

Parent rev.

Child rev.

[Not reviewed]

0 1 0

Brett Smith - 3 years ago 2021-03-09 20:48:30
brettcsmith@brettcsmith.org

query: Add a user hint for query TypeErrors.

The error message that native bean-query provides when this happens
confuses many users. Add a hint to point them in the right direction.

1 file changed with 9 insertions and 0 deletions:

conservancy_beancount/reports/query.py

0 comments (0 inline, 0 general)

conservancy_beancount/reports/query.py

➞

Show inline comments

@@ ... / @@ -193,96 +193,105 @@ class BooksLoader: @@
                     postings = ruleset.rewrite(postings)
                 try:
                     result.entries[index] = entry._replace(postings=list(postings))  # type:ignore[call-arg]
                 except AttributeError:
                     pass
             logger.debug("rewrite rules applied")
         return result
 class BQLShell(bc_query_shell.BQLShell):
     def __init__(
             self,
             is_interactive: bool,
             loadfun: Callable[[], books.LoadResult],
             outfile: TextIO,
             default_format: str='text',
             do_numberify: bool=False,
             rt_wrapper: Optional[rtutil.RT]=None,
     ) -> None:
         super().__init__(is_interactive, loadfun, outfile, default_format, do_numberify)
         self.env_postings = FilterPostingsEnvironment()
         self.env_targets = TargetsEnvironment()
         self.ods = QueryODS(rt_wrapper)
     def on_Select(self, statement: QueryStatement) -> None:
         output_format: str = self.vars['format']
         try:
             render_func = getattr(self, f'_render_{output_format}')
         except AttributeError:
             logger.error("unknown output format %r", output_format)
             return
         try:
             logger.debug("compiling query")
             compiled_query = bc_query_compile.compile(
                 statement, self.env_targets, self.env_postings, self.env_entries,
+            )
             logger.debug("executing query")
             row_types, rows = bc_query_execute.execute_query(
                 compiled_query, self.entries, self.options_map,
+            )
             if self.vars['numberify']:
                 logger.debug("numberifying query")
                 row_types, rows = bc_query_numberify.numberify_results(
                     row_types, rows, self.options_map['dcontext'].build(),
+                )
         except Exception as error:
             logger.error(str(error), exc_info=logger.isEnabledFor(logging.DEBUG))
             if (isinstance(error, TypeError)
                 and error.args
                 and ' not supported between instances ' in error.args[0]):
                 logger.info(
                     "HINT: Are you using ORDER BY or comparisons with metadata "
                     "that isn't consistently set?\n  "
                     "Try looking up that metadata with str_meta() instead to "
                     "ensure your comparisons use a consistent data type.",
+                )
             return
         if not rows and output_format != 'ods':
             print("(empty)", file=self.outfile)
         else:
             logger.debug("rendering query as %s", output_format)
             render_func(statement, row_types, rows)
     def _render_csv(self, statement: QueryStatement, row_types: RowTypes, rows: Rows) -> None:
         bc_query_render.render_csv(
             row_types,
             rows,
             self.options_map['dcontext'],
             self.outfile,
             self.vars['expand'],
+        )
     def _render_ods(self, statement: QueryStatement, row_types: RowTypes, rows: Rows) -> None:
         self.ods.write_query(statement, row_types, rows)
         logger.info(
             "%s rows of results saved in sheet %s",
             len(rows),
             self.ods.sheet.getAttribute('name'),
+        )
     def _render_text(self, statement: QueryStatement, row_types: RowTypes, rows: Rows) -> None:
         with contextlib.ExitStack() as stack:
             if self.is_interactive:
                 output = stack.enter_context(self.get_pager())
             else:
                 output = self.outfile
             bc_query_render.render_text(
                 row_types,
                 rows,
                 self.options_map['dcontext'],
                 output,
                 self.vars['expand'],
                 self.vars['boxed'],
                 self.vars['spaced'],
+            )
 class QueryODS(core.BaseODS[NamedTuple, None]):
     META_FNAMES = frozenset([
         # Names of functions, as defined in Environments, that look up
         # posting metadata that could contain documentation links
         'any_meta',
         'entry_meta',

0 comments (0 inline, 0 general)