NPO-Accounting/conservancy_beancount Changeset - 741e6628943d

Changeset - 741e6628943d

Parent rev.

Child rev.

[Not reviewed]

0 3 0

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

query: Add original query as a comment to ODS output.

This is generally helpful to keep for future reference, plus this
presentation can support multiple queries and is more discoverable than the
previous file property.

3 files changed with 38 insertions and 4 deletions:

conservancy_beancount/reports/core.py

conservancy_beancount/reports/query.py

setup.py

0 comments (0 inline, 0 general)

conservancy_beancount/reports/core.py

➞

Show inline comments

@@ ... / @@ -20,15 +20,17 @@ import urllib.parse as urlparse @@
 import babel.core  # type:ignore[import]
 import babel.numbers  # type:ignore[import]
 import git  # type:ignore[import]
 import odf.config  # type:ignore[import]
 import odf.dc  # type:ignore[import]
 import odf.element  # type:ignore[import]
 import odf.meta  # type:ignore[import]
 import odf.number  # type:ignore[import]
 import odf.office  # type:ignore[import]
 import odf.opendocument  # type:ignore[import]
 import odf.style  # type:ignore[import]
 import odf.table  # type:ignore[import]
 import odf.text  # type:ignore[import]
 from decimal import Decimal
@@ ... @@
         generator_elem = self.ensure_child(self.document.meta, odf.meta.Generator)
         generator_elem.childNodes.clear()
         generator_elem.addText(f'{generator}/{cliutil.VERSION} {TOOLSVERSION}')
     ### Rows and cells
     def add_annotation(
             self,
             text: Optional[str]=None,
             when: Optional[datetime.datetime]=None,
             parent: Optional[odf.table.TableCell]=None,
     ) -> odf.office.Annotation:
         if when is None:
             when = datetime.datetime.now()
         retval = odf.office.Annotation()
         retval.appendChild(odf.dc.Date(text=when.isoformat(timespec='seconds')))
         if text is not None:
             retval.appendChild(odf.text.P(text=text))
         if parent is not None:
             parent.appendChild(retval)
         return retval
     def add_row(self, *cells: odf.table.TableCell, **attrs: Any) -> odf.table.TableRow:
         row = odf.table.TableRow(**attrs)
         for cell in cells:
             row.addElement(cell)
         self.sheet.addElement(row)
         return row

conservancy_beancount/reports/query.py

➞

Show inline comments

@@ ... / @@ -210,12 +210,21 @@ class BQLShell(bc_query_shell.BQLShell): @@
             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)
         self.last_line_parsed = ''
     def run_parser(
             self,
             line: str,
             default_close_date: Optional[datetime.datetime]=None,
     ) -> None:
         self.last_line_parsed = line
         super().run_parser(line, default_close_date)
     def on_Select(self, statement: QueryStatement) -> None:
         output_format: str = self.vars['format']
         try:
             render_func = getattr(self, f'_render_{output_format}')
         except AttributeError:
@@ ... / @@ -262,13 +271,13 @@ class BQLShell(bc_query_shell.BQLShell): @@
             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)
+        self.ods.write_query(statement, row_types, rows, self.last_line_parsed)
         logger.info(
             "%s rows of results saved in sheet %s",
             len(rows),
             self.ods.sheet.getAttribute('name'),
+        )
@@ ... / @@ -397,13 +406,19 @@ class QueryODS(core.BaseODS[NamedTuple, None]): @@
                 yield self._cell_type(row_type)
             elif meta_key in data.LINK_METADATA:
                 yield self._link_cell_type(row_type)
             else:
                 yield self._metadata_cell
     def write_query(self, statement: QueryStatement, row_types: RowTypes, rows: Rows) -> None:
     def write_query(
             self,
             statement: QueryStatement,
             row_types: RowTypes,
             rows: Rows,
             query_string: Optional[str]=None,
     ) -> None:
         if self.is_empty():
             self.sheet.setAttribute('name', "Query 1")
         else:
             self.use_sheet(f"Query {len(self.document.spreadsheet.childNodes) + 1}")
         for name, row_type in row_types:
             if issubclass(row_type, datetime.date):
@@ ... / @@ -416,12 +431,14 @@ class QueryODS(core.BaseODS[NamedTuple, None]): @@
             self.sheet.addElement(odf.table.TableColumn(stylename=col_style))
         self.add_row(*(
             self.string_cell(data.Metadata.human_name(name), stylename=self.style_bold)
             for name, _ in row_types
         ))
         self.lock_first_row()
         if query_string:
             self.add_annotation(query_string, parent=self.sheet.lastChild.firstChild)
         cell_funcs = list(self._cell_types(statement, row_types))
         for row in rows:
             self.add_row(*(
                 cell_func(value)
                 for cell_func, value in zip(cell_funcs, row)
             ))
@@ ... / @@ -573,13 +590,12 @@ def main(arglist: Optional[Sequence[str]]=None, @@
         shell.onecmd(query)
     else:
         shell.cmdloop()
     if not shell.ods.is_empty():
         shell.ods.set_common_properties(config.books_repo())
         shell.ods.set_custom_property('BeanQuery', query or '<interactive>')
         if args.output_file is None:
             out_dir_path = config.repository_path() or Path()
             args.output_file = out_dir_path / 'QueryResults_{}.ods'.format(
                 datetime.datetime.now().isoformat(timespec='seconds'),
+            )
             logger.info("Writing spreadsheet to %s", args.output_file)

setup.py

➞

Show inline comments

@@ ... / @@ -2,13 +2,13 @@ @@
 from setuptools import setup
 setup(
     name='conservancy_beancount',
     description="Plugin, library, and reports for reading Conservancy's books",
-    version='1.18.4',
+    version='1.19.0',
     author='Software Freedom Conservancy',
     author_email='info@sfconservancy.org',
     license='GNU AGPLv3+',
     install_requires=[
         'babel>=2.6',  # Debian:python3-babel

0 comments (0 inline, 0 general)