uzoncalc 1.0.1__tar.gz

uzoncalc-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 uyoufu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

uzoncalc-1.0.1/PKG-INFO

@@ -0,0 +1,302 @@
+Metadata-Version: 2.4
+Name: uzoncalc
+Version: 1.0.1
+Summary: UzonCalc is a tool for writing engineering calculation documents using Python. With it, you can write calculation reports as smoothly as writing Python, and benefit from the full Python ecosystem and AI assistance.
+Home-page: https://github.com/uyoufu/UzonCalc
+Author: uyoufu
+Author-email: uyoufu@uzoncloud.com
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pint
+Requires-Dist: numpy
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# UzonCalc
+
+[中文](README.zh-CN.md)
+
+UzonCalc is a tool for writing engineering calculation documents using Python. With it, you can write calculation reports as smoothly as writing Python, and benefit from the full Python ecosystem and AI assistance.
+
+## Features
+
+1. Write using Python code — no extra syntax to learn
+2. Benefit from the Python ecosystem and AI support
+3. Focus on calculations, not layout
+4. Output beautiful HTML directly; convertible to PDF and Docx
+
+## Start
+
+**Installation**
+
+``` bash
+pip install uzoncalc
+```
+
+**Copy Template**
+
+``` Python
+# example.py
+from uzoncalc import *
+
+@uzon_calc()
+def sheet():
+    doc_title("uzoncalc example")
+
+    "Hello, UzonCalc!"
+
+    save()
+
+
+if __name__ == "__main__":
+    sheet()
+```
+
+**Execution**
+
+``` python
+python example.py
+```
+
+## Example
+
+``` python
+from numpy import sqrt
+from pathlib import Path
+import sys
+
+# Ensure project root is on sys.path so `import core` works when running
+# this script from the `core` folder.
+sys.path.insert(0, str(Path(__file__).resolve().parents[1]))
+
+
+from core.setup import uzon_calc
+from core.utils import *
+from core.utils_extra.excel import get_excel_table
+
+
+@uzon_calc()
+def sheet():
+    doc_title("UzonCalc Full Example")
+    page_size("A4")
+
+    H1("UzonCalc Full Example")
+
+    "This is a full example demonstrating various features of UzonCalc."
+
+    toc()
+
+    # description:
+    # this is a full example of using UzonCalc.
+
+    H2("Auto Table of Contents")
+    "You can automatically generate a table of contents for your document."
+
+    H2("Basic Constants")
+    # number
+    H3("Numbers")
+    intNumber = 100
+    floatNumber = 3.1415
+    scientificNumber = 1.2e3
+    complexNumber = 2 + 3j
+
+    H3("Strings")
+    helloString = "Hello,"
+    uzonCalcString = "UzonCalc!"
+    greeting = helloString + uzonCalcString
+
+    H3("String Output")
+    # you can output strings directly
+    "This is a string output inline."
+
+    """
+    This is a string output block.
+    It can span multiple lines.
+    It will be rendered as paragraph.
+    """
+
+    H3("String Formatting")
+    name = "Uzon"
+    f"Hello, {name}! Welcome to UzonCalc."
+    pi = 3.1415926535
+    f"Value of pi up to 3 decimal places: {pi:.3f}"
+
+    H3("String Formatting With Equations")
+    enable_fstring_equation()
+    f"Hello, {name}! Welcome to UzonCalc."
+    f"The value of pi is approximately {pi:.3f}, which is useful in calculations."
+    disable_fstring_equation()
+
+    H2("Units and Calculations")
+    length = 5 * unit.meter
+    time = 2 * unit.second
+    speed = length / time
+
+    H3("Complex Calculation")
+
+    acceleration = speed / time
+    force = 10 * unit.kilogram * acceleration
+    stress = force / (length**2)
+
+    H3("Unit Conversion")
+    "Original speed in m/s:"
+    speed
+    hide()
+    speedKmh = speed.to(unit.kilometer / unit.hour)
+    show()
+    f"Speed in km/h: {speedKmh}"
+
+    # use matplotlib to plot a sine wave
+    H2("Plotting Example")
+    "You can use Matplotlib to create plots within UzonCalc."
+    hide()
+    import numpy as np
+    import matplotlib.pyplot as plt
+
+    x = np.linspace(0, 2 * np.pi, 100)
+    y = np.sin(x)
+    plt.plot(x, y)
+    plt.title("Sine Wave")
+    plt.xlabel("x (radians)")
+    plt.ylabel("sin(x)")
+    plt.legend(["sin(x)"])
+    plt.grid(True)
+    show()
+    Plot(plt)
+
+    # sub
+    H2("Variable subscription")
+
+    H3("Default Subscript Rule")
+
+    "if you want to make a word to be subscript, you can use _ after it. For example, H_2 will be rendered as H₂."
+    a_x = 10 * unit.meter / unit.second**2
+    speed_2 = a_x * 2 * unit.second
+
+    H3("complex Subscript")
+
+    "You can also use other language characters as subscripts, like gamma_混凝土."
+    "You can use alias"
+
+    H3("Array Subscript")
+    "You can use array subscript like A[i]."
+
+    # 希腊字母
+    H2("Greek Letters")
+    "You can use Greek letters like 'alpha' (α), 'beta' (β), 'gamma' (γ), 'delta' (δ), etc. in your calculations."
+    "When you write 'alpha', it will be rendered as α."
+    "Capitalized Greek letters like 'Beta' will be rendered as Β."
+
+    rho_water = 1000 * unit.kilogram / unit.meter**3
+    g = 9.81 * unit.meter / unit.second**2
+    h = 10 * unit.meter
+    pressure = rho_water * g * h
+    "Pressure calculated using ρgh:"
+    pressure
+
+    H2("Functions Converter")
+
+    "Some functions can automatically convert to math style."
+
+    H3("Square Root")
+    "You can use sqrt(x) to represent the square root of x."
+
+    edge1 = 3 * unit.meter
+    edge2 = 4 * unit.meter
+    diagonal = sqrt(edge1**2 + edge2**2)
+
+    H3("Absolute Value")
+    "You can use abs(x) to represent the absolute value of x."
+    value = -15 * unit.newton
+    absValue = abs(value)
+
+    H2("Tables")
+
+    "You can create tables to organize data."
+
+    Table(
+        [
+            [
+                th("Component", rowspan=3),
+                th("Material", rowspan=3),
+                th("Elastic Modulus (MPa)", colspan=2),
+                th("Design Strength (MPa)", colspan=2),
+                th("Standard Strength (MPa)", colspan=2),
+            ],
+            [
+                "Ec/Es",
+                "Compressive",
+                "Tensile",
+                "Compressive",
+                "Tensile",
+            ],
+        ],
+        [
+            ["Cap Beam", "C60", 3.6e4, 26.5, 1.96, 38.5, 2.85],
+            ["Cap Beam 2", "C60", 3.6e4, 26.5, 1.96, 38.5, 2.85],
+        ],
+        title="Sample Table",
+    )
+
+    H2("Call Excel Calculation")
+
+    "You can update values for Excel calculation and get results table back."
+    "This is very useful for re-using of existing Excel calculation."
+
+    P(
+        get_excel_table(
+            excel_path="examples/calculation.xlsx",
+            values={
+                "A3": 6,
+                "B3": 10,
+                "C3": 2,
+            },
+            range="A1:D3",
+        )
+    )
+
+    "Excel table will be cached for faster rendering next time if cache=True and the input values are not changed."
+
+    H2("Saving Document")
+
+    H3("Save as HTML")
+
+    "You can save the document as an HTML file using the save() function."
+
+    H3("Export To Word Document")
+
+    "You can export the html document to a word document by pandoc command."
+
+    from core.utils.doc import save
+
+    save("../output/example.en.html")
+
+
+if __name__ == "__main__":
+    import time
+
+    t0 = time.perf_counter()
+    sheet()  # type: ignore
+    t1 = time.perf_counter()
+    print(f"Execution time: {t1 - t0} seconds")
+
+```
+
+Preview:
+
+![image-20260110162359040](https://oss.uzoncloud.com:2234/public/files/images/image-20260110162359040.png)
+
+
+## Demo
+
+Source: [example.en.py](https://github.com/uyoufu/UzonCalc/blob/master/examples/example.en.py)
+
+Compile Result: [UzonCalc Full Example](https://calc.uzoncloud.com/example.en.html)

uzoncalc-1.0.1/README.md

@@ -0,0 +1,280 @@
+# UzonCalc
+
+[中文](README.zh-CN.md)
+
+UzonCalc is a tool for writing engineering calculation documents using Python. With it, you can write calculation reports as smoothly as writing Python, and benefit from the full Python ecosystem and AI assistance.
+
+## Features
+
+1. Write using Python code — no extra syntax to learn
+2. Benefit from the Python ecosystem and AI support
+3. Focus on calculations, not layout
+4. Output beautiful HTML directly; convertible to PDF and Docx
+
+## Start
+
+**Installation**
+
+``` bash
+pip install uzoncalc
+```
+
+**Copy Template**
+
+``` Python
+# example.py
+from uzoncalc import *
+
+@uzon_calc()
+def sheet():
+    doc_title("uzoncalc example")
+
+    "Hello, UzonCalc!"
+
+    save()
+
+
+if __name__ == "__main__":
+    sheet()
+```
+
+**Execution**
+
+``` python
+python example.py
+```
+
+## Example
+
+``` python
+from numpy import sqrt
+from pathlib import Path
+import sys
+
+# Ensure project root is on sys.path so `import core` works when running
+# this script from the `core` folder.
+sys.path.insert(0, str(Path(__file__).resolve().parents[1]))
+
+
+from core.setup import uzon_calc
+from core.utils import *
+from core.utils_extra.excel import get_excel_table
+
+
+@uzon_calc()
+def sheet():
+    doc_title("UzonCalc Full Example")
+    page_size("A4")
+
+    H1("UzonCalc Full Example")
+
+    "This is a full example demonstrating various features of UzonCalc."
+
+    toc()
+
+    # description:
+    # this is a full example of using UzonCalc.
+
+    H2("Auto Table of Contents")
+    "You can automatically generate a table of contents for your document."
+
+    H2("Basic Constants")
+    # number
+    H3("Numbers")
+    intNumber = 100
+    floatNumber = 3.1415
+    scientificNumber = 1.2e3
+    complexNumber = 2 + 3j
+
+    H3("Strings")
+    helloString = "Hello,"
+    uzonCalcString = "UzonCalc!"
+    greeting = helloString + uzonCalcString
+
+    H3("String Output")
+    # you can output strings directly
+    "This is a string output inline."
+
+    """
+    This is a string output block.
+    It can span multiple lines.
+    It will be rendered as paragraph.
+    """
+
+    H3("String Formatting")
+    name = "Uzon"
+    f"Hello, {name}! Welcome to UzonCalc."
+    pi = 3.1415926535
+    f"Value of pi up to 3 decimal places: {pi:.3f}"
+
+    H3("String Formatting With Equations")
+    enable_fstring_equation()
+    f"Hello, {name}! Welcome to UzonCalc."
+    f"The value of pi is approximately {pi:.3f}, which is useful in calculations."
+    disable_fstring_equation()
+
+    H2("Units and Calculations")
+    length = 5 * unit.meter
+    time = 2 * unit.second
+    speed = length / time
+
+    H3("Complex Calculation")
+
+    acceleration = speed / time
+    force = 10 * unit.kilogram * acceleration
+    stress = force / (length**2)
+
+    H3("Unit Conversion")
+    "Original speed in m/s:"
+    speed
+    hide()
+    speedKmh = speed.to(unit.kilometer / unit.hour)
+    show()
+    f"Speed in km/h: {speedKmh}"
+
+    # use matplotlib to plot a sine wave
+    H2("Plotting Example")
+    "You can use Matplotlib to create plots within UzonCalc."
+    hide()
+    import numpy as np
+    import matplotlib.pyplot as plt
+
+    x = np.linspace(0, 2 * np.pi, 100)
+    y = np.sin(x)
+    plt.plot(x, y)
+    plt.title("Sine Wave")
+    plt.xlabel("x (radians)")
+    plt.ylabel("sin(x)")
+    plt.legend(["sin(x)"])
+    plt.grid(True)
+    show()
+    Plot(plt)
+
+    # sub
+    H2("Variable subscription")
+
+    H3("Default Subscript Rule")
+
+    "if you want to make a word to be subscript, you can use _ after it. For example, H_2 will be rendered as H₂."
+    a_x = 10 * unit.meter / unit.second**2
+    speed_2 = a_x * 2 * unit.second
+
+    H3("complex Subscript")
+
+    "You can also use other language characters as subscripts, like gamma_混凝土."
+    "You can use alias"
+
+    H3("Array Subscript")
+    "You can use array subscript like A[i]."
+
+    # 希腊字母
+    H2("Greek Letters")
+    "You can use Greek letters like 'alpha' (α), 'beta' (β), 'gamma' (γ), 'delta' (δ), etc. in your calculations."
+    "When you write 'alpha', it will be rendered as α."
+    "Capitalized Greek letters like 'Beta' will be rendered as Β."
+
+    rho_water = 1000 * unit.kilogram / unit.meter**3
+    g = 9.81 * unit.meter / unit.second**2
+    h = 10 * unit.meter
+    pressure = rho_water * g * h
+    "Pressure calculated using ρgh:"
+    pressure
+
+    H2("Functions Converter")
+
+    "Some functions can automatically convert to math style."
+
+    H3("Square Root")
+    "You can use sqrt(x) to represent the square root of x."
+
+    edge1 = 3 * unit.meter
+    edge2 = 4 * unit.meter
+    diagonal = sqrt(edge1**2 + edge2**2)
+
+    H3("Absolute Value")
+    "You can use abs(x) to represent the absolute value of x."
+    value = -15 * unit.newton
+    absValue = abs(value)
+
+    H2("Tables")
+
+    "You can create tables to organize data."
+
+    Table(
+        [
+            [
+                th("Component", rowspan=3),
+                th("Material", rowspan=3),
+                th("Elastic Modulus (MPa)", colspan=2),
+                th("Design Strength (MPa)", colspan=2),
+                th("Standard Strength (MPa)", colspan=2),
+            ],
+            [
+                "Ec/Es",
+                "Compressive",
+                "Tensile",
+                "Compressive",
+                "Tensile",
+            ],
+        ],
+        [
+            ["Cap Beam", "C60", 3.6e4, 26.5, 1.96, 38.5, 2.85],
+            ["Cap Beam 2", "C60", 3.6e4, 26.5, 1.96, 38.5, 2.85],
+        ],
+        title="Sample Table",
+    )
+
+    H2("Call Excel Calculation")
+
+    "You can update values for Excel calculation and get results table back."
+    "This is very useful for re-using of existing Excel calculation."
+
+    P(
+        get_excel_table(
+            excel_path="examples/calculation.xlsx",
+            values={
+                "A3": 6,
+                "B3": 10,
+                "C3": 2,
+            },
+            range="A1:D3",
+        )
+    )
+
+    "Excel table will be cached for faster rendering next time if cache=True and the input values are not changed."
+
+    H2("Saving Document")
+
+    H3("Save as HTML")
+
+    "You can save the document as an HTML file using the save() function."
+
+    H3("Export To Word Document")
+
+    "You can export the html document to a word document by pandoc command."
+
+    from core.utils.doc import save
+
+    save("../output/example.en.html")
+
+
+if __name__ == "__main__":
+    import time
+
+    t0 = time.perf_counter()
+    sheet()  # type: ignore
+    t1 = time.perf_counter()
+    print(f"Execution time: {t1 - t0} seconds")
+
+```
+
+Preview:
+
+![image-20260110162359040](https://oss.uzoncloud.com:2234/public/files/images/image-20260110162359040.png)
+
+
+## Demo
+
+Source: [example.en.py](https://github.com/uyoufu/UzonCalc/blob/master/examples/example.en.py)
+
+Compile Result: [UzonCalc Full Example](https://calc.uzoncloud.com/example.en.html)

uzoncalc-1.0.1/core/__init__.py

@@ -0,0 +1,5 @@
+from .setup import uzon_calc, uzon_calc_core, get_current_instance
+from .units import unit
+from .utils import *
+from .utils_extra import *
+from .context import CalcContext

uzoncalc-1.0.1/core/context.py

@@ -0,0 +1,98 @@
+from typing import Any
+import os
+from .context_options import ContextOptions
+from .db.json_db import JsonDB
+
+
+class CalcContext:
+    def __init__(self, *, name: str | None = None, file_path: str | None = None):
+        self.name = name or "calc_ctx" + hex(id(self))
+        self.file_path = file_path
+
+        self.options = ContextOptions()
+
+        # 记录结果
+        self.__contents = []
+
+        # 记录行内内容的临时存储
+        self.__inline_values: list[str] | None = None
+        self.__inline_separator: str = " "
+
+        # sqlite
+        self.json_db: None | JsonDB = None
+
+    @property
+    def contents(self):
+        return self.__contents
+
+    # region content recording
+    def append_content(self, content: str):
+        if self.options.skip_content:
+            return
+
+        # 对 content 进行后处理
+        for handler in self.options.post_handlers:
+            content = handler.handle(content, ctx=self)
+
+        # 若有 row_values，则添加到 row_values 中
+        # 在其它地方将其转换成一行内容
+        if self.__inline_values is not None:
+            self.__inline_values.append(content)
+            return
+
+        self.__contents.append(content)
+
+    def start_inline(self, separator: str = " "):
+        self.__inline_separator = separator
+        if self.__inline_values is not None:
+            return
+
+        self.__inline_values = []
+
+    def end_inline(self):
+        if self.__inline_values:
+            combined = self.__inline_separator.join(self.__inline_values)
+            # 将整行内容包装在 <p> 标签中
+            self.__contents.append(f"<p>{combined}</p>")
+            self.__inline_values = None
+
+    @property
+    def is_inline_mode(self) -> bool:
+        """检查是否处于 inline 模式"""
+        return self.__inline_values is not None
+
+    # endregion
+
+    # region result generation
+    def html_content(self) -> str:
+        return "\n".join(self.__contents)
+
+    # endregion
+
+    def get_location_dir(self) -> str:
+        """
+        获取当前上下文文件所在目录
+        若 file_path 未设置，则返回当前工作目录
+        """
+        if self.file_path:
+            return os.path.dirname(os.path.abspath(self.file_path))
+        return os.getcwd()
+
+    def get_json_db(self) -> JsonDB:
+        """
+        获取 SQLite 游标
+        若尚未创建数据库连接，则创建一个内存数据库连接
+        """
+        if self.json_db is not None:
+            return self.json_db
+
+        dir = self.get_location_dir()
+
+        # 开始连接
+        self.json_db = JsonDB(os.path.join(dir, f"data/db.json"))
+        return self.json_db
+
+    def exit(self):
+        """退出上下文，关闭数据库连接等"""
+        if self.json_db is not None:
+            self.json_db.save()