pydocmaker 2.2.2__tar.gz → 2.2.5__tar.gz

{pydocmaker-2.2.2/src/pydocmaker.egg-info → pydocmaker-2.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pydocmaker
-Version: 2.2.2
+Version: 2.2.5
 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.2 → pydocmaker-2.2.5}/src/pydocmaker/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.2.2'
+__version__ = '2.2.5'
 
 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.2 → pydocmaker-2.2.5}/src/pydocmaker/backend/baseformatter.py

@@ -7,7 +7,7 @@ import os
 from jinja2 import Template
 
 def _handle_template(template, default_template):
-    if not template:
+    if template is None:
         template = default_template
 
     attachments = {}
@@ -16,6 +16,8 @@ def _handle_template(template, default_template):
     elif isinstance(template, str) and os.path.exists(template):
         with open(template, 'r') as fp:
             template_obj = Template(fp.read())
+    elif isinstance(template, str) and not template:
+        template_obj = Template('{{ body }}')
     elif isinstance(template, str):
         template_obj = Template(template)
     else:

{pydocmaker-2.2.2 → pydocmaker-2.2.5}/src/pydocmaker/backend/ex_tex.py

@@ -16,6 +16,7 @@ import sys
 import tempfile
 import shutil
 from io import BytesIO
+import warnings
 
 import zipfile
 import latex
@@ -119,7 +120,7 @@ def auto_escape_latex(params):
     elif isinstance(params, dict):
         return {k:auto_escape_latex(v) for k, v in params.items()}
     elif isinstance(params, list):
-        return [auto_escape_latex(v) for k, v in params.items()]
+        return [auto_escape_latex(v) for v in params]
     else:
         return params
 
@@ -149,6 +150,11 @@ def convert(doc:List[dict], with_attachments=True, files_to_upload=None, templat
     body = '\n'.join(s) if isinstance(s, list) else s
 
     template_obj, attachments = _handle_template(template, __default_template)
+    if template == '':
+        s = 'It seems you have provided an empty template to use.'
+        s += '\nThis will most likely fail, since LaTeX actually needs imports etc. to work.'
+        s += '\nI will try anyways though.'
+        warnings.warn(s)
     
     kw = copy.deepcopy(template_params)
     if do_escape_template_params:

{pydocmaker-2.2.2 → pydocmaker-2.2.5}/src/pydocmaker/backend/pdf_maker.py

@@ -102,6 +102,24 @@ def _procrun(args, verb=0, ignore_error=False, **kwargs):
             raise Exception(s)
     return process.returncode
 
+def _get_platform_tempdir():
+    import platform
+    # HACK: Stupid windows sometimes has a tilde in the user path and PDFlatex does not like this
+    # therefore we need to expand the user name using ctypes. 
+    # NOTE: os.path.expanduser(tempfile.tempdir) does not work for this either
+    if platform.system().lower() == "windows":
+        # Use the Windows API to get the full long path (remove tilde)
+        import ctypes
+        buf_size = ctypes.windll.kernel32.GetLongPathNameW(tempfile.gettempdir(), None, 0)
+        if buf_size == 0:
+            return tempfile.gettempdir()  # In case GetLongPathNameW fails, return original path
+        buffer = ctypes.create_unicode_buffer(buf_size)
+        ctypes.windll.kernel32.GetLongPathNameW(tempfile.gettempdir(), buffer, buf_size)
+        return buffer.value
+    else:
+        # For Unix-like systems (Linux, macOS), plug in None to indicate to use 
+        return None
+    
 
 def make_pdf_from_tex(input_latex_text, attachments_dc=None, docname='', out_format='pdf', base_dir=None, latex_compiler=None, n_times_make=None, verb=0, ignore_error=False) -> bytes:
     """Converts a LaTeX document to a PDF or a ZIP file containing the PDF and all attachments.
@@ -156,6 +174,9 @@ def make_pdf_from_tex(input_latex_text, attachments_dc=None, docname='', out_for
         
     if verb: print(f'Running with {latex_compiler=}')
 
+    if base_dir is None:
+        base_dir = _get_platform_tempdir() # need this to deal with windows and tilde chars
+        
     # open a temp folder at base dir which will be deleted after completion
     with tempfile.TemporaryDirectory(dir=base_dir) as output_dir:
         out_file_tex = f'{docname}.tex'

{pydocmaker-2.2.2 → pydocmaker-2.2.5}/src/pydocmaker/core.py

@@ -483,7 +483,8 @@ class DocBuilder(UserList):
         except KeyError as err:
             if 'my_template_id=' in str(err):
                 tformat = 'Any' if not tformat else tformat
-                warnings.warn(f'The {template_id=} was defined for this document, and the current serializer tried to get it with the format="{tformat}", but it could not be resolved.\nWill continue without template. Original Error message\n' + str(err) )
+                s = f'The {template_id=} was defined for this document, and the current serializer tried to get it with the format="{tformat}", but it could not be resolved.\nWill continue without template. Original Error message\n' + str(err) 
+                warnings.warn(s)
                 return None
             else:
                 raise
@@ -593,32 +594,40 @@ class DocBuilder(UserList):
         self.update_meta(dc)
         return dc
 
-    def set_meta(self, data, **kwargs):
+    def set_meta(self, *args, **kwargs):
         """
-        Sets the metadata for the object.
-
-        Args:
-            data (dict): The metadata to be set.
-            **kwargs: Additional keyword arguments to be added to the metadata.
+        Sets the metadata for this document. 
+        Use by either
+        .set_meta({'doc_name': 'test'})
+        or
+        .set_meta(doc_name='test') 
 
         Returns:
             dict: The updated metadata.
         """
+        data = next(iter(args), {})
+        data.update(kwargs)
+
         meta = self.get_meta()
         if meta is None:
-            return self.add_meta(data, **kwargs)
+            return self.add_meta(data)
         else:
             if not 'data' in meta:
                 meta['data'] = {}
             meta['data'].clear()
             meta['data'].update(data)
-            meta['data'].update(**kwargs)
             return meta['data']
         
     def get_meta(self, default=None):
-        """gets the (first) metadata element in this document if it exists. If not returns None"""
+        """gets the (first) meta element in this document if it exists. If not returns None"""
         return next((k for k in self if isinstance(k, dict) and k.get('typ') == 'meta'), default)
     
+    def get_metadata(self):
+        """Equivalent to self.get_meta(default={}).get('data', {})
+        Gets the data of the (first) meta element in this document if it exists. 
+        If not exists an new empty dict is returned"""
+        return self.get_meta(default={}).get('data', {})
+    
     def has_meta(self) -> bool:
         """tests if this document has one or more metadata objects"""
         return False if self.get_meta() is None else True
@@ -639,7 +648,7 @@ class DocBuilder(UserList):
         
         data = next(iter(args), {})
         meta = self.get_meta()
-        data.update(**kwargs)
+        data.update(kwargs)
         if meta is None: 
             return self.add_meta(data)
         else:
@@ -662,7 +671,7 @@ class DocBuilder(UserList):
             dict: the meta elements data (content)
         """
         data = next(iter(args), {})
-        data.update(**kwargs)
+        data.update(kwargs)
 
         if self.has_meta():
             return self.update_meta(data)
@@ -962,7 +971,7 @@ class DocBuilder(UserList):
 
         
 
-    def to_pdf(self, path_or_stream=None, docname='', files_to_upload=None, base_dir=None, latex_compiler=None, n_times_make=None, verb=1, ignore_error=True, template=None, template_params=None, do_escape_template_params='auto'):
+    def to_pdf(self, path_or_stream=None, docname='', files_to_upload=None, base_dir=None, latex_compiler=None, n_times_make=None, verb=1, ignore_error=True, template=None, template_params=None, do_escape_template_params='auto', **kwargs):
         """Converts the current object to a PDF file or zipped latex project folder.
 
         Args:
@@ -994,6 +1003,8 @@ class DocBuilder(UserList):
         if files_to_upload is None:
             files_to_upload = {}
             
+        files_to_upload.update(kwargs.pop('additional_files', {}))
+
         params = {}
         meta = self.get_meta(default={}).get('data', {})
         mytemplate = self.get_template_from_meta(tformat='tex')
@@ -1063,7 +1074,7 @@ class DocBuilder(UserList):
     
 
     
-    def to_tex(self, path_or_stream=None, additional_files=None, template = None, do_escape_template_params='auto', template_params=None):
+    def to_tex(self, path_or_stream=None, additional_files=None, template = None, do_escape_template_params='auto', template_params=None, text_only=False):
         """Converts the current object to a TEX file (and attachments).
 
         Args:
@@ -1072,6 +1083,7 @@ class DocBuilder(UserList):
             template (str, optional): The LaTeX template to use.
             do_escape_template_params (bool, optional): Whether to escape the template parameters. "auto" will scan for %%latex at the start of a string to determine if its a latex string. Defaults to 'auto'.
             template_params (dict, optional): Additional parameters to pass to the LaTeX template.
+            text_only (bool, optional): Only valid if path_or_stream is None. Whether or not to return attachments as well. Defaults to False
 
         Returns:
             If saving to a file or stream:
@@ -1122,9 +1134,12 @@ class DocBuilder(UserList):
             path_or_stream.write(m)
             return True
         else:
-            return tex, files
+            if text_only:
+                return tex
+            else:
+                return tex, files
     
-    def to_textile(self, path_or_stream=None):
+    def to_textile(self, path_or_stream=None, text_only=False):
         """
         Converts the current object to a TEXTILE file (and attachments). 
         If path_or_stream is given it will zip all contents and write it to the stream or file path given.
@@ -1132,6 +1147,7 @@ class DocBuilder(UserList):
 
         Args:
             path_or_stream (str or io.IOBase, optional): The path to save the file to, or a file-like object to write the data to. If not provided, the data will be returned as string.
+            text_only (bool, optional): Only valid if path_or_stream is None. Whether or not to return attachments as well. Defaults to False
         """
         
         textile, files = to_textile(self.dump(), with_attachments=True, aformat_redmine=False)
@@ -1152,7 +1168,10 @@ class DocBuilder(UserList):
             path_or_stream.write(m)
             return True
         else:
-            return textile, files
+            if text_only:
+                return textile
+            else:
+                return textile, files
         
     def to_redmine(self):
         """
@@ -1394,24 +1413,29 @@ class DocBuilder(UserList):
         
         engine = engine.lower()
 
+        
+        if engine in ['html', 'pdf', 'tex']:
+            kwargs['additional_files'] = files_to_upload
+            kwargs['template'] = template
+            kwargs['template_params'] = template_params
+
+        if engine in ['pdf', 'tex']:
+            kwargs['do_escape_template_params'] = do_escape_template_params
+
         if index:
-            DocBuilder([self[index]]).show()
+            DocBuilder([self[index]]).show(**kwargs)
         elif chapter:
-            DocBuilder(self.get_chapter(chapter)).show()
+            DocBuilder(self.get_chapter(chapter)).show(**kwargs)
         
         if is_notebook():
-            from IPython.display import display, HTML, Markdown, IFrame, Code
+            from IPython.display import display, HTML, Markdown, Code
             if engine in 'html'.split():
                 display(HTML(self.to_html(**kwargs)))
             elif engine in 'markdown md'.split():
                 display(Markdown(self.to_markdown()))
             elif engine in 'tex latex'.split():
-                display(Code(self.to_tex(**kwargs)[0], language='tex'))
+                display(Code(self.to_tex(text_only=True, **kwargs), language='tex'))
             elif engine == 'pdf':
-                kwargs['files_to_upload'] = files_to_upload
-                kwargs['template'] = template
-                kwargs['template_params'] = template_params
-                kwargs['do_escape_template_params'] = do_escape_template_params
                 pdf_bytes = self.to_pdf(**kwargs)
                 show_pdf(pdf_bytes)
             else:
@@ -1423,7 +1447,7 @@ class DocBuilder(UserList):
             elif engine in 'markdown md'.split():
                 print(self.to_markdown(embed_images=False, **kwargs))
             elif engine in 'tex latex'.split():
-                print(self.to_tex(**kwargs)[0])
+                print(self.to_tex(text_only=True, **kwargs))
             else:
                 raise KeyError(f'engine must be in: "html", "markdown", "md", "tex", or "latex", but was {engine=}')
             

{pydocmaker-2.2.2 → pydocmaker-2.2.5}/src/pydocmaker/templating.py

@@ -1,6 +1,7 @@
 
 import os
 import json
+from typing import List
 
 from jinja2 import Environment, FileSystemLoader, ChoiceLoader
 
@@ -118,7 +119,7 @@ class TemplateDirSource():
     """
 
 
-    def __init__(self, template_dirs:list[str]=None) -> None:
+    def __init__(self, template_dirs:List[str]=None) -> None:
         
         if template_dirs is None:
             template_dirs = get_registered_template_dirs(include_default=True)
@@ -337,6 +338,12 @@ class DocTemplate():
         self.env = env
         self.template_id = template_id
 
+    def __str__(self):
+        return f"TemplateObject(id={self.template_id}, template={self.template}, params.keys()={self.params.keys()})"
+
+    def __repr__(self):
+        return self.__str__()
+
     def render(self, **kwargs):
         """Render the Jinja2 template with given parameters.
 

{pydocmaker-2.2.2 → pydocmaker-2.2.5/src/pydocmaker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pydocmaker
-Version: 2.2.2
+Version: 2.2.5
 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