Separate equation into its own file. User should not have to fire up …

…a onedoc class only to convert functions to latex/word snippets

src/paradoc/__init__.py

@@ -1,4 +1,5 @@
 from .common import MY_DOCX_TMPL, MY_DOCX_TMPL_BLANK
 from .document import OneDoc
+from .equations import Equation
 
-__all__ = [MY_DOCX_TMPL, MY_DOCX_TMPL_BLANK, OneDoc]
+__all__ = [MY_DOCX_TMPL, MY_DOCX_TMPL_BLANK, OneDoc, Equation]

src/paradoc/common.py

@@ -3,7 +3,7 @@
 import pathlib
 import re
 from dataclasses import dataclass, field
-from typing import Callable, List, Union
+from typing import List, Union
 
 import pandas as pd
 
@@ -72,45 +72,6 @@ class Figure:
     docx_instances: List[object] = field(default_factory=list)
 
 
-@dataclass
-class Equation:
-    name: str
-    func: Callable
-    custom_eq_str_compiler: Callable = None
-    add_link: bool = True
-    include_python_code: bool = False
-    md_instances: List[MarkDownFile] = field(default_factory=list)
-    docx_instances: List[object] = field(default_factory=list)
-
-    def to_latex(self, print_latex=False, print_formula=False, flags=None):
-        if self.custom_eq_str_compiler is not None:
-            return self.custom_eq_str_compiler(self.func)
-
-        from inspect import getsource, getsourcelines
-
-        import pytexit
-
-        lines = getsourcelines(self.func)
-        eq_latex = ""
-        matches = ("def", "return", '"')
-        dots = 0
-        for line in lines[0]:
-            if any(x in line for x in matches):
-                dots += line.count('"')
-                dots += line.count("'")
-                continue
-            if dots >= 6 or dots == 0:
-                eq_latex += pytexit.py2tex(line, print_latex=print_latex, print_formula=print_formula) + "\n"
-        eq_str = eq_latex
-
-        if self.add_link:
-            eq_str += f"{{#eq:{self.name}}}"
-
-        if self.include_python_code:
-            eq_str = f"\n\n```python\n{getsource(self.func)}\n```\n\n" + eq_str
-        return eq_str
-
-
 @dataclass
 class DocXFormat:
     pg_font: str = "Arial"

src/paradoc/document.py

@@ -8,15 +8,8 @@
 
 import pandas as pd
 
-from .common import (
-    DocXFormat,
-    Equation,
-    ExportFormats,
-    Figure,
-    MarkDownFile,
-    Table,
-    TableFormat,
-)
+from .common import DocXFormat, ExportFormats, Figure, MarkDownFile, Table, TableFormat
+from .equations import Equation
 from .exceptions import LatexNotInstalled
 from .utils import get_list_of_files
 

src/paradoc/equations.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Callable, List
+
+from .common import MarkDownFile
+
+
+@dataclass
+class Equation:
+    name: str
+    func: Callable
+    custom_eq_str_compiler: Callable = None
+    add_link: bool = True
+    include_python_code: bool = False
+    md_instances: List[MarkDownFile] = field(default_factory=list)
+    docx_instances: List[object] = field(default_factory=list)
+
+    def to_latex(self, print_latex=False, print_formula=False, flags=None):
+        if self.custom_eq_str_compiler is not None:
+            return self.custom_eq_str_compiler(self.func)
+
+        from inspect import getsource, getsourcelines
+
+        import pytexit
+
+        lines = getsourcelines(self.func)
+        eq_latex = ""
+        matches = ("def", "return", '"')
+        dots = 0
+        for line in lines[0]:
+            if any(x in line for x in matches):
+                dots += line.count('"')
+                dots += line.count("'")
+                continue
+            if dots >= 6 or dots == 0:
+                eq_latex += pytexit.py2tex(line, print_latex=print_latex, print_formula=print_formula) + "\n"
+        eq_str = eq_latex
+
+        if self.add_link:
+            eq_str += f"{{#eq:{self.name}}}"
+
+        if self.include_python_code:
+            eq_str = f"\n\n```python\n{getsource(self.func)}\n```\n\n" + eq_str
+        return eq_str

src/paradoc/utils.py

@@ -5,7 +5,8 @@
 
 import pypandoc
 
-from .common import Equation, MarkDownFile, Table
+from .common import MarkDownFile, Table
+from .equations import Equation
 
 
 def func_to_eq(func):