pydocmaker 2.2.7__tar.gz → 2.2.8__tar.gz

{pydocmaker-2.2.7/src/pydocmaker.egg-info → pydocmaker-2.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pydocmaker
-Version: 2.2.7
+Version: 2.2.8
 Summary: a minimal document maker to make docx, markdown, html, textile, redmine, and tex documents from python. Written in pure python.
 Home-page: https://github.com/TobiasGlaubach/pydocmaker
 Author: Tobias Glaubach

{pydocmaker-2.2.7 → pydocmaker-2.2.8}/src/pydocmaker/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.2.7'
+__version__ = '2.2.8'
 
 from pydocmaker.core import DocBuilder, construct, constr, buildingblocks, print_to_pdf, get_latex_compiler, set_latex_compiler, make_pdf_from_tex, show_pdf
 from pydocmaker.util import upload_report_to_redmine, bcolors, txtcolor, colors_dc

{pydocmaker-2.2.7 → pydocmaker-2.2.8}/src/pydocmaker/backend/baseformatter.py

@@ -31,7 +31,7 @@ class BaseFormatter(abc.ABC):
     default_linebreak = '\n\n'
 
     def digest_iterator(self, **kwargs):
-        content = kwargs.get('content', kwargs.get('children'))
+        content = kwargs.get('children', kwargs.get('content'))
         return f''.join([self.digest(c) for c in content])
 
     def digest_str(self, el):
@@ -46,6 +46,10 @@ class BaseFormatter(abc.ABC):
     def digest_meta(self, **kwargs):
         return '' # meta element will not influence the rendering and is just ignored
     
+    @abc.abstractmethod
+    def digest_table(self, children=None, **kwargs) -> str:
+        pass
+
     @abc.abstractmethod
     def digest_markdown(self, children='', **kwargs) -> str:
         pass
@@ -65,13 +69,14 @@ class BaseFormatter(abc.ABC):
     def digest(self, children, **kwargs) -> str:
         try:
             
-
             if not children:
                 ret = ''
             elif isinstance(children, str):
                 ret = self.digest_str(children)
             elif isinstance(children, dict) and children.get('typ', None) == 'meta':
                 ret = self.digest_meta(children=children, **kwargs)
+            elif isinstance(children, dict) and children.get('typ', None) == 'table':
+                ret = self.digest_table(**children, **kwargs)
             elif isinstance(children, dict) and children.get('typ', None) == 'iter':
                 ret = self.digest_iterator(children=children, **kwargs)
             elif isinstance(children, list) and children:
@@ -103,9 +108,11 @@ class BaseFormatter(abc.ABC):
                     linebreak = tmp
 
                 ret += linebreak
+
             return ret
         
         except Exception as err:
+            raise
             return self.handle_error(err, children)
 
 
@@ -131,3 +138,37 @@ class BaseFormatter(abc.ABC):
     
 
 
+    def _map_table2mat(self, children=None, **kwargs) -> str:
+        if children is None:
+            children = [[]]
+
+        assert isinstance(children, (list, tuple)), f'children must be of type list! but was {type(children)=} {children=}'
+        header = kwargs.get('header', None)
+        header = list(header) if header else []
+
+        assert isinstance(header, (list, tuple)), f'header must be of type list! but was {type(header)=} {header=}'
+        data = list(children)
+        wrong_rows = [row for row in children if not isinstance(row, (list, tuple))]
+        assert not wrong_rows, f'all rows must be of type list! but found {wrong_rows=}'
+
+        n_rows = kwargs.get('n_rows', None)
+        if n_rows is None:
+            n_rows = len(data)
+        n_cols = kwargs.get('n_cols', None)
+        if n_cols is None:
+            n_cols = max(len(header), max([len(row) for row in data]))
+        
+        head = [self.digest(el) for el in header]
+        if len(head) < n_cols:
+            head += ['']*(n_cols-len(head))
+
+        mat = []
+        for i in range(n_rows):
+            mat.append(['']*n_cols)
+
+        for irow, row in enumerate(data):
+            for icol, el in enumerate(row):
+                mat[irow][icol] = self.digest(el)
+
+        return head, mat
+    

{pydocmaker-2.2.7 → pydocmaker-2.2.8}/src/pydocmaker/backend/ex_docx.py

@@ -98,7 +98,9 @@ class docx_renderer(BaseFormatter):
             return [self.digest(val, *args, **kwargs) for val in children]
         return []
 
-
+    def digest_table(self, children=None, **kwargs) -> str:
+        self.handle_error(NotImplementedError(f'exporter of type {type(self)} can not handle tables'))
+    
     def digest_image(self, children, *args, **kwargs):
 
         image_width = Inches(max(1, kwargs.get('width', 0.8)*5))

{pydocmaker-2.2.7 → pydocmaker-2.2.8}/src/pydocmaker/backend/ex_html.py

@@ -225,3 +225,35 @@ class html_renderer(BaseFormatter):
             children += [f'<div style="width: 100%; text-align: center;"><span style="min-width:100;display: inline-block;"><b>caption: </b>{caption}</span></div>']
 
         return '\n\n'.join(children)
+
+    def digest_table(self, children=None, **kwargs) -> str:
+        borders = kwargs.pop('borders', None)
+        if borders is None:
+            borders = True
+        caption = kwargs.pop('caption', '')
+        if not caption:
+            caption = ''
+
+        head, mat = self._map_table2mat(children=children, **kwargs)
+        lines = []
+        st = ' style="border: 1px solid black;"' if borders else ''
+
+        lines.append('<table style="border-collapse: collapse; margin-left: auto; margin-right: auto;">')
+        lines.append("  <tr>")
+        lines += [f"    <th{st}>{h}</th>" for h in head]
+        lines.append("  </tr>")
+        for row in mat:
+            lines.append("  <tr>")
+            lines += [f"    <td{st}>{cell}</td>" for cell in row]
+            lines.append("  </tr>")
+
+        lines.append("</table>")
+
+        body = '\n'.join(lines)
+        txt = f'<div>{body}</div>'
+
+        if caption:
+            txt += f'\n<div style="text-align: center;"><span style="min-width:100;display: inline-block;"><b>Caption: </b>{caption}</span></div>'
+
+        return txt
+        

{pydocmaker-2.2.7 → pydocmaker-2.2.8}/src/pydocmaker/backend/ex_ipynb.py

@@ -191,6 +191,10 @@ class ipynb_renderer(BaseFormatter):
         self.cells += [make_markdown(content)]
         return ''
     
+    def digest_table(self, children=None, **kwargs) -> str:
+        self.handle_error(NotImplementedError(f'exporter of type {type(self)} can not handle tables'))
+    
+
     def digest_image(self,imageblob=None, children='', width=0.8, caption="", **kwargs):       
         
         if imageblob is None:

{pydocmaker-2.2.7 → pydocmaker-2.2.8}/src/pydocmaker/backend/ex_markdown.py

@@ -23,6 +23,29 @@ class DocumentMarkdownFormatter(BaseFormatter):
     def digest_markdown(self, children='', **kwargs) -> list:
         return children
     
+    def digest_table(self, children=None, **kwargs) -> str:
+        borders = kwargs.pop('borders', None)
+        if borders is None:
+            borders = True
+        caption = kwargs.pop('caption', '')
+        if not caption:
+            caption = ''
+
+        head, mat = self._map_table2mat(children=children, **kwargs)
+        striprow = lambda x: [str(xx).strip() for xx in x]
+
+        header = '| ' + ' | '.join(striprow(head)) + ' |'
+        separator = '|' + (' --- |' if borders else ' ---:|') * len(head)
+        rows = ['| ' + ' | '.join(striprow(row)) + ' |' for row in mat]
+        body = '\n'.join([header, separator] + rows)
+    
+        if caption:
+            body += f'\n\n**Caption:** {caption}\n'
+
+        return body
+
+   
+        
     def digest_image(self, **kwargs) -> list:
         
         filename = kwargs.get('filename')
@@ -49,18 +72,23 @@ class DocumentMarkdownFormatter(BaseFormatter):
         lines.append('')
 
         # HACK: handle non PNG type properly!
+        if imageblob.startswith('data:image/png;base64,'):
+            i = imageblob
+        else:
+            i = 'data:image/png;base64,' + str(imageblob)
+
         if self.embed_images:
-            lines.append(f'![{description}](data:image/png;base64,{imageblob})')
+            lines.append(f'![{description}]({i})')
         else:
-            i = imageblob[:20] + f'... (n={len(imageblob)-20} more chars hidden))' if len(imageblob) > 20 else imageblob
-            lines.append(f'#[{description}](data:image/png;base64,{i}')
+            i = i[:35] + f'... (n={len(i)-35} more chars hidden))' if len(i) > 35 else i
+            lines.append(f'#[{description}]({i}')
         lines.append('')
 
         if caption:
             lines.append(f'*caption:* {filename}')
             lines.append('')
 
-        return lines
+        return '\n'.join(lines)
     
 
     def digest_verbatim(self, children='', **kwargs) -> list:

{pydocmaker-2.2.7 → pydocmaker-2.2.8}/src/pydocmaker/backend/ex_redmine.py

@@ -5,7 +5,12 @@ try:
     from pydocmaker.backend.baseformatter import BaseFormatter
 except Exception as err:
     from .baseformatter import BaseFormatter
-
+    
+try:
+    from pydocmaker.backend.pandoc_api import can_run_pandoc, pandoc_convert
+except Exception as err:
+    from .pandoc_api import can_run_pandoc, pandoc_convert
+    
 
 def convert(doc:List[dict], with_attachments=True, aformat_redmine=False):
 
@@ -89,12 +94,16 @@ class DocumentRedmineFormatter(BaseFormatter):
 
     @handle_color
     def digest_markdown(self, children='', **kwargs) -> str:
-        return children
+        if can_run_pandoc():
+            return pandoc_convert(children, 'markdown', 'textile')
+        else:
+            return children
 
     @handle_color
     def digest_text(self, children='', **kwargs) -> str:
         return children
     
+
     def digest_image(self, **kwargs) -> str:
         filename, content = im2file(kwargs)
         attachment = im2attachment(kwargs, filename, content)
@@ -110,8 +119,11 @@ class DocumentRedmineFormatter(BaseFormatter):
         return s
     
     def digest_latex(self, children='', **kwargs) -> str:
-        return self.digest_verbatim(children=children, **kwargs)
-
+        if can_run_pandoc():
+            return pandoc_convert(children, 'latex', 'textile')
+        else:
+            return self.digest_verbatim(children=children, **kwargs)
+        
     @handle_color
     def digest_verbatim(self, children='', **kwargs) -> str:
         if isinstance(children, str):
@@ -123,33 +135,23 @@ class DocumentRedmineFormatter(BaseFormatter):
         return s
 
     
-    def parse_md2html(self, s) -> str:
-        return markdown.markdown(s, extensions=['extra', 'toc'])
-
-    def parse_md2textile_line(self, line):
-        r = re.match(r'([ \t]*)#+', line)
-        n = r.group().count('#') if r else None
-        if n:
-            line = re.sub(r'([ \t]*)#+', rf'\1h{n}. ', line)
-
-        r = re.match(r'^([ \t]*-{1}[ ]{1})', line)
-        if r:
-            g = r.group()
-            line = line.replace(g, ('*'*len(g)) + ' ')
-
-        return line
-
-    
-
-    def parse_md2textile(self, s) -> str:
-        f = self.parse_md2textile_line
-        lines = [f(line) for line in s.split('\n')]
-        s = '\n'.join(lines)
-        # code blocks
-        s = re.sub(r"(```)([\s\S]*?)(?=```)(```)", r'<pre>\2</pre>', s)
-
-        # links
-        s = re.sub(r"(\[)([\s\S]*?)(?=\])(\])(\()([\s\S]*?)(?=\))(\))", r'"\2":\5', s)
+    def digest_table(self, children=None, **kwargs) -> str:
+        borders = kwargs.pop('borders', None)
+        if borders is None:
+            borders = True
+        caption = kwargs.pop('caption', '')
+        if not caption:
+            caption = ''
+
+        head, mat = self._map_table2mat(children=children, **kwargs)
+        striprow = lambda x: [str(xx).strip() for xx in x]
+
+        header = '|_.' + ' |_.'.join(striprow(head)) + ' |'
         
-        return s
-        
+        rows = ['| ' + ' |'.join(striprow(row)) + ' |' for row in mat]
+        body = '\n'.join([header] + rows)
+        if caption:
+            body += f'\n\nCaption: {caption}\n'
+        return body
+    
+   

{pydocmaker-2.2.7 → pydocmaker-2.2.8}/src/pydocmaker/backend/ex_tex.py

@@ -427,3 +427,60 @@ class LatexElementFormatter(BaseFormatter):
     def digest_line(self, children:str, **kwargs):
         return replace_bcolors(str(children))
 
+
+    def digest_table(self, children=None, **kwargs) -> str:
+        borders = kwargs.pop('borders', None)
+        if borders is None:
+            borders = True
+
+        caption = kwargs.pop('caption', '')
+        if not caption:
+            caption = ''
+
+        head, mat = self._map_table2mat(children=children, **kwargs)
+        if not head and not mat[0]:
+            return ''
+        
+
+        striprow = lambda x: [str(xx).strip() for xx in x]
+        bold = lambda x: '\\textbf{' + str(x).strip() + '}'
+
+        n_cols = len(head) if head else len(mat[0])
+
+        lines = []
+        if borders:
+            lines.append(r'\hline')
+
+        if head:
+            lines.append(' & '.join([bold(hh) for hh in head]) + r' \\')
+            if borders:
+                lines.append(r'\hline')
+        for row in mat:
+            lines.append(' & '.join(striprow(row)) + r' \\')
+            if borders:
+                lines.append(r'\hline')
+        
+        if not borders:
+            d = ' '.join(['c'] * n_cols)
+        else:
+            d = '|' + '|'.join(['c'] * n_cols) + '|'
+
+        if caption:
+            caption = '\\caption{%s}' % (escape(caption))
+            
+            txt = '''\\begin{table}[h!]
+\centering
+\\begin{tabular}{ %s }
+%s 
+\end{tabular}
+%s
+\end{table}''' % (d, '\n'.join(lines), caption)
+        else:
+            txt = '''\\begin{center}
+\\begin{tabular}{ %s }
+%s 
+\end{tabular}
+\end{center}''' % (d, '\n'.join(lines))
+
+        return txt  
+

{pydocmaker-2.2.7 → pydocmaker-2.2.8}/src/pydocmaker/core.py

@@ -144,6 +144,15 @@ class constr():
             'end': end
         }
     
+    @staticmethod
+    def line(children='', color='', end=None):
+        return {
+            'typ': 'line',
+            'children': children,
+            'color': color,
+            'end': '\n' if end is None else end
+        }
+    
     @staticmethod
     def latex(children='', color='', end=None):
         return {
@@ -172,6 +181,20 @@ class constr():
             'end': end
         }
     
+    @staticmethod
+    def table(children:list=None, color='', end=None, header=None, caption=None, n_cols=None, n_rows=None, borders=True):
+        return {
+            'typ': 'table',
+            'children': children,
+            'n_cols': n_cols,
+            'n_rows': n_rows,
+            'borders': borders,
+            'header': header,
+            'caption': caption,
+            'color': color,
+            'end': end,
+        }
+    
     @staticmethod
     def image(imageblob='', caption='', children='', width=0.8, color='', end=None):
 
@@ -789,7 +812,29 @@ class DocBuilder(UserList):
         self.add(construct('markdown', children=children, color=color, end=end, **kwargs), index=index, chapter=chapter)
         return self
     
+    def add_table(self, children=None, index=None, chapter=None, color='', end=None, header=None, caption='', n_rows=None, n_cols=None, borders=True, **kwargs):
+        """add a table element to this document
 
+        Args:
+            children (list of lists): the "children" for this element. Must be a matrix (list of lists) with formatable elements in it.
+            index (int, optional): The index where to insert the part. If None, appends to the end.
+            chapter (str | int, optional): The chapter name or index where to insert the part. If None, appends to the end.
+            color (str, optional): any color which can be rendered by html or latex. Empty string for default.
+            end (str, optional): If you want to insert a different line ending (than the default) for this element set this argument to any string. None for default.
+            header (list, optional): The header row for the table. If given it must be a list with formatable elements in it.
+            caption (str, optional): The caption to place at/under the table. Empty for no caption.
+            n_rows (int, optional): The number of rows to give this table. If not given it will be determined from the number of rows in children.
+            n_cols (int, optional): The number of columns to give this table. If not given it will be determined from the max number of columns in all rows in children.
+            borders (bool, optional): Whether or not the table should have lines between its cells.
+        """
+        if header: kwargs['header'] = header
+        if n_rows: kwargs['n_rows'] = n_rows
+        if n_cols: kwargs['n_cols'] = n_cols
+        if borders: kwargs['borders'] = borders
+        if caption: kwargs['caption'] = caption
+        self.add(constr.table(children=children, color=color, end=end, **kwargs), index=index, chapter=chapter)
+        return self
+    
     def add_pre(self, children=None, index=None, chapter=None, color='', end=None, **kwargs):
         """add a verbaim (pre formatted) document part to this document
 
@@ -1495,6 +1540,17 @@ function metamorphose(protagonist,author){
 }
         """)
         doc.add_tex("\\textit{This is some dummy LaTeX text.}")
+
+        doc.add_md("this is how to embed a table:")
+
+        header = ['Name', 'Age', 'City']
+        table = [
+            ['John Doe', "30", 'New York'],
+            ['Jane Smith', "25", 'Los Angeles'],
+            ['Mike Johnson', "35", 'Chicago']
+        ]
+        doc.add_table(table, header=header, borders=True, caption='This is my example table')
+
         doc.add('And this is how to embed an Image:')
         doc.add_image(image="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEYAAAAUCAAAAAAVAxSkAAABrUlEQVQ4y+3TPUvDQBgH8OdDOGa+oUMgk2MpdHIIgpSUiqC0OKirgxYX8QVFRQRpBRF8KShqLbgIYkUEteCgFVuqUEVxEIkvJFhae3m8S2KbSkcFBw9yHP88+eXucgH8kQZ/jSm4VDaIy9RKCpKac9NKgU4uEJNwhHhK3qvPBVO8rxRWmFXPF+NSM1KVMbwriAMwhDgVcrxeMZm85GR0PhvGJAAmyozJsbsxgNEir4iEjIK0SYqGd8sOR3rJAGN2BCEkOxhxMhpd8Mk0CXtZacxi1hr20mI/rzgnxayoidevcGuHXTC/q6QuYSMt1jC+gBIiMg12v2vb5NlklChiWnhmFZpwvxDGzuUzV8kOg+N8UUvNBp64vy9q3UN7gDXhwWLY2nMC3zRDibfsY7wjEkY79CdMZhrxSqqzxf4ZRPXwzWJirMicDa5KwiPeARygHXKNMQHEy3rMopDR20XNZGbJzUtrwDC/KshlLDWyqdmhxZzCsdYmf2fWZPoxCEDyfIvdtNQH0PRkH6Q51g8rFO3Qzxh2LbItcDCOpmuOsV7ntNaERe3v/lP/zO8yn4N+yNPrekmPAAAAAElFTkSuQmCC")
         

{pydocmaker-2.2.7 → pydocmaker-2.2.8/src/pydocmaker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pydocmaker
-Version: 2.2.7
+Version: 2.2.8
 Summary: a minimal document maker to make docx, markdown, html, textile, redmine, and tex documents from python. Written in pure python.
 Home-page: https://github.com/TobiasGlaubach/pydocmaker
 Author: Tobias Glaubach

{pydocmaker-2.2.7 → pydocmaker-2.2.8}/tests/test_ex_html.py

@@ -32,6 +32,19 @@ class TestHtmlRenderer(unittest.TestCase):
         result = self.formatter.digest({'typ': 'verbatim'})
         self.assertIsInstance(result, str)
 
+    def test_digest_table(self):
+        result = self.formatter.digest([['element1', 'element2']])
+        self.assertIsInstance(result, str)
+
+        dc = {
+            'children': [['element1', 'element2']], 
+            'header': ['h1', 'h2'], 
+            'n_cols': 3, 
+            'typ': 'table'
+        }
+        result = self.formatter.digest(dc)
+        self.assertIsInstance(result, str)
+
     def test_digest_iterator(self):
         result = self.formatter.digest(['element1', 'element2'])
         self.assertIsInstance(result, str)
@@ -62,6 +75,7 @@ class TestHtmlRenderer(unittest.TestCase):
         self.assertIsInstance(res, str)
         self.assertTrue(res)
 
+
 if __name__ == '__main__':
     unittest.main()