flinventory 0.6.10__tar.gz → 0.6.12__tar.gz

{flinventory-0.6.10 → flinventory-0.6.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flinventory
-Version: 0.6.10
+Version: 0.6.12
 Summary: An inventory system for self-help repair shops
 Author-Email: flukx <flinventory-flukx@612211124.xyz>
 License: GPL3

{flinventory-0.6.10 → flinventory-0.6.12}/flinventory/signprinter_latex.py

@@ -5,11 +5,12 @@ Todo:
     rename font size to text scale. Because it is used to scale instead of setting
     a font size. So the 'normal' is not 12 (pt) but 1.
 """
+import argparse
 import importlib.resources
 import os.path
 import logging
 import subprocess
-from typing import Union, Iterable, Optional
+from typing import Union, Iterable, Optional, cast
 
 from .box import BoxedThing
 from .sign import Sign
@@ -89,12 +90,32 @@ def sanitize_latex_code(latex: Union[str, int, float]):
             (">", "\\textgreater{}"),
             ("|", "\\textbar{}"),
         ]:
-            latex = latex.replace(orig, new)
+            latex = cast(str, latex).replace(orig, new)
     except AttributeError:
         pass
     return latex
 
 
+class LaTeXError(Exception):
+    """Exception saying that LaTeX exited non-gracefully."""
+
+    def __init__(
+        self, message: str, call: list[str], input_file: str, return_code: int
+    ):
+        """Create LaTeXError.
+
+        Args:
+            message: general message as for every exception
+            call: LaTeX call sent to the console
+            input_file: tex file processed (probably included in call)
+            return_code: Return call of the LaTeX command, non-zero
+        """
+        super().__init__(message)
+        self.call = call
+        self.input_file = input_file
+        self.return_code = return_code
+
+
 class SignPrinterLaTeX:
     # pylint: disable=too-many-instance-attributes
     """Class encapsulating algorithm for creating printable signs from thing list.
@@ -129,7 +150,11 @@ class SignPrinterLaTeX:
         return file_contents
 
     def controlled_length(
-        self, sign: Sign, key: str, backup: Union[int, float], max: Union[int, float]
+        self,
+        sign: Sign,
+        key: str,
+        backup: Union[int, float],
+        maximum: Union[int, float],
     ):
         """Get the value for the key if it exists and is a number and < max, otherwise backup."""
         value = sign.get(key, backup)
@@ -147,8 +172,8 @@ class SignPrinterLaTeX:
             )
             return backup
         if value == int(value):
-            return min(int(value), max)
-        return min(value, max)
+            return min(int(value), maximum)
+        return min(value, maximum)
 
     def width(self, thing: BoxedThing) -> Union[int, float]:
         """Get the width of a sign, using backup and max size.
@@ -156,13 +181,13 @@ class SignPrinterLaTeX:
         In UNIT.
         """
         return self.controlled_length(
-            thing.sign, key="width", backup=STANDARD_WIDTH, max=MAX_WIDTH
+            thing.sign, key="width", backup=STANDARD_WIDTH, maximum=MAX_WIDTH
         )
 
     def height(self, thing: BoxedThing) -> Union[int, float]:
         """Get the height of the sign of a boxed thing, using backup and max size."""
         return self.controlled_length(
-            thing.sign, key="height", backup=STANDARD_HEIGHT, max=MAX_HEIGHT
+            thing.sign, key="height", backup=STANDARD_HEIGHT, maximum=MAX_HEIGHT
         )
 
     def image_height_vspace(
@@ -178,20 +203,19 @@ class SignPrinterLaTeX:
         if sign_height < MINIMAL_HEIGHT_FOR_IMAGE:
             return (
                 self.controlled_length(
-                    thing.sign, key="imageheight", backup=0, max=sign_height
+                    thing.sign, key="imageheight", backup=0, maximum=sign_height
                 ),
                 r"-1.5\baselineskip",
             )
-        else:
-            return (
-                self.controlled_length(
-                    thing.sign,
-                    key="imageheight",
-                    backup=sign_height * IMAGE_SHARE,
-                    max=sign_height,
-                ),
-                "1pt",
-            )
+        return (
+            self.controlled_length(
+                thing.sign,
+                key="imageheight",
+                backup=sign_height * IMAGE_SHARE,
+                maximum=sign_height,
+            ),
+            "1pt",
+        )
 
     def if_use_landscape_template(self, thing: BoxedThing):
         """Return if we want to use the landscape template for this thing.
@@ -221,7 +245,6 @@ class SignPrinterLaTeX:
         #    return self.guess_font_size_landscape(thing)
         return self.guess_font_size_portrait(thing)
 
-    @staticmethod
     def guess_font_size_landscape(thing):
         """Guess good font sizes for the landscape template."""
         assert False, "landscape latex signs are not supperted"
@@ -272,7 +295,12 @@ class SignPrinterLaTeX:
         german_words = german.replace("-", "- ").split() or [" "]
         english_words = english.replace("-", " ").split() or [" "]
         # ignore cases with more than 2 lines, should be considered by hand
-        max_font_sizes = [[0, 0, 0], [0, 0, 0], [0, 0, 0], [0, 0, 0]]
+        max_font_sizes: list[list[int | float]] = [
+            [0, 0, 0],
+            [0, 0, 0],
+            [0, 0, 0],
+            [0, 0, 0],
+        ]
         # there are 4 line number cases, see below in for loop
         GERMAN_INDEX = 0  # pylint: disable=invalid-name
         ENGLISH_INDEX = 1  # pylint: disable=invalid-name
@@ -411,7 +439,7 @@ class SignPrinterLaTeX:
                 content_latex.append(
                     ""
                 )  # empty line in code makes new line (= row) in pdf
-                current_line_filled_width = 0
+                current_line_filled_width = 0.0
             content_latex.append(self.create_sign(thing))
             current_line_filled_width += self.width(thing)
         content_latex.append(self.post)
@@ -502,9 +530,9 @@ class SignPrinterLaTeX:
         Arguments:
             things: list of things to visualize
         Returns:
-            path to created file. None in case of error.
+            path to created file.
         """
-        things.sort(key=lambda t: self.height(t))
+        things.sort(key=self.height)
         file_signs = os.path.join(self.output_dir, self.signs_file)
         print(f"Print LaTeX file to {file_signs}.")
         with open(file_signs, mode="w", encoding="UTF-8") as latex_file:
@@ -516,16 +544,28 @@ class SignPrinterLaTeX:
 
         Raises:
             ProgramMissingError: if no latexmk is available
+            LaTeXError: if LaTeX exited with non-zero return code
+        Returns:
+            path to created pdf file
         """
         self.save_signs_latex(things)
+        latex: (
+            subprocess.CalledProcessError
+            | subprocess.CompletedProcess
+            | argparse.Namespace
+        )
         try:
             latex = subprocess.run(
                 LATEXMK_OPTIONS + [self.signs_file],
                 cwd=self.output_dir,
                 capture_output=True,
                 text=True,
+                check=True,
             )  # text=True makes output a str instead of bytes
         except FileNotFoundError as program_missing:
+            latex = argparse.Namespace(
+                stdout="No LaTeX output.", stderr="LaTeX not found."
+            )
             if program_missing.filename == LATEXMK_OPTIONS[0]:
                 raise constant.MissingProgramError(
                     LATEXMK_OPTIONS[0],
@@ -533,21 +573,36 @@ class SignPrinterLaTeX:
                     f"Program {LATEXMK_OPTIONS[0]} missing.",
                     program_missing.filename,
                 ) from program_missing
-            else:
-                raise program_missing
-        with open(
-            os.path.join(self.output_dir, AUX_DIR, "latex_output.txt"), mode="w"
-        ) as stdout_file:
-            stdout_file.write(latex.stdout)
-        with open(
-            os.path.join(self.output_dir, AUX_DIR, "latex_error.txt"), mode="w"
-        ) as stderr_file:
-            stderr_file.write(latex.stderr)
-        if latex.returncode != 0:
-            print(
+            raise program_missing
+        except subprocess.CalledProcessError as latex_error:
+            latex = latex_error  # includes output, stderr
+            message = (
                 f"Latex finished with returncode {latex.returncode}."
                 f"Check in {os.path.join(self.output_dir, AUX_DIR)} for details."
             )
+            print(message)
+            raise LaTeXError(
+                message,
+                call=latex_error.cmd,
+                input_file=self.signs_file,
+                return_code=latex_error.returncode,
+            ) from latex_error
+        finally:
+            with open(
+                os.path.join(self.output_dir, AUX_DIR, "latex_output.txt"),
+                mode="w",
+                encoding="utf-8",
+            ) as stdout_file:
+                stdout_file.write(latex.stdout)
+            with open(
+                os.path.join(self.output_dir, AUX_DIR, "latex_error.txt"),
+                mode="w",
+                encoding="utf-8",
+            ) as stderr_file:
+                stderr_file.write(latex.stderr)
+        pdf_file = os.path.splitext(self.signs_file)[0] + ".pdf"
+        assert os.path.isfile(pdf_file)
+        return pdf_file
 
     def create_sign_svg(self, thing: BoxedThing) -> Optional[str]:
         """Create a svg from a pdf with a sign for this thing.

{flinventory-0.6.10 → flinventory-0.6.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flinventory"
-version = "0.6.10"
+version = "0.6.12"
 description = "An inventory system for self-help repair shops"
 authors = [
     { name = "flukx", email = "flinventory-flukx@612211124.xyz" },