Merge pull request #14 from youandvern/add-symbolic-class

Introduce Symbolic class for displaying strings, equations, etc. without a calculated value
youandvern · May 27, 2024 · bf099a7 · bf099a7
2 parents 9eea4d8 + 00ca3f4
commit bf099a7
Show file tree

Hide file tree

Showing 40 changed files with 641 additions and 108 deletions.
diff --git a/Makefile b/Makefile
@@ -3,14 +3,17 @@
 build:
 	python -m build
 
-tests:
-	python -m pytest
-
 publish:
 	python -m twine upload --skip-existing dist/*
 
+# within venv
+tests:
+	python -m pytest
+
+# within venv
 docs:
 	sphinx-build docs_src docs
 
+# within venv
 sections:
 	python -m "build_section_tables.py"
diff --git a/README.md b/README.md
@@ -4,9 +4,9 @@
 
 <p align="center">
   <a href="https://github.com/youandvern/efficalc/actions/workflows/tests.yml"><img alt="Tests" src="https://github.com/youandvern/efficalc/actions/workflows/tests.yml/badge.svg"></a>&nbsp;&nbsp;&nbsp;
-  <a href="https://coveralls.io/github/youandvern/efficalc?branch=main"><img alt="Coverage Status" src="https://coveralls.io/repos/github/youandvern/efficalc/badge.svg?branch=main&v=1.1.0"></a>&nbsp;&nbsp;&nbsp;
+  <a href="https://coveralls.io/github/youandvern/efficalc?branch=main"><img alt="Coverage Status" src="https://coveralls.io/repos/github/youandvern/efficalc/badge.svg?branch=main&v=1.2.0"></a>&nbsp;&nbsp;&nbsp;
   <a href="https://github.com/youandvern/efficalc/blob/main/LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>&nbsp;&nbsp;&nbsp;
-  <a href="https://badge.fury.io/py/efficalc"><img alt="PyPI version" src="https://badge.fury.io/py/efficalc.svg?v=1.1.0"></a>
+  <a href="https://badge.fury.io/py/efficalc"><img alt="PyPI version" src="https://badge.fury.io/py/efficalc.svg?version=1.2.0"></a>
 </p>
 
 

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e986a32d4ebbf8f991ab225314dbe723
+config: 0b61954b10429afc60dfc155a8e18b44
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/base_classes.doctree b/docs/.doctrees/base_classes.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/_sources/base_classes.rst.txt b/docs/_sources/base_classes.rst.txt
@@ -27,6 +27,10 @@ Base Classes
     :members:
 
 
+.. autoclass:: efficalc.Symbolic
+    :members:
+
+
 .. autoclass:: efficalc.TextBlock
     :members:
 

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.1.0',
+    VERSION: '1.2.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_static/efficalc_basic_demo_typing.jpg b/docs/_static/efficalc_basic_demo_typing.jpg
diff --git a/docs/base_classes.html b/docs/base_classes.html
diff --git a/docs/calculation_helpers.html b/docs/calculation_helpers.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Section Properties" href="section_properties.html" /><link rel="prev" title="Figures in Calc Reports" href="figures.html" />
 
     <link rel="shortcut icon" href="_static/favicon.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>Calculation Helpers - efficalc 1.1.0 documentation</title>
+        <title>Calculation Helpers - efficalc 1.2.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -126,7 +126,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">efficalc 1.1.0 documentation</div></a>
+      <a href="index.html"><div class="brand">efficalc 1.2.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -152,7 +152,7 @@
     <img class="sidebar-logo" src="_static/efficalc.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">efficalc 1.1.0 documentation</span>
+  <span class="sidebar-brand-text">efficalc 1.2.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -472,7 +472,7 @@
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=fc837d61"></script>
+</div><script src="_static/documentation_options.js?v=6efca38a"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/docs/constants.html b/docs/constants.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Styling Reports" href="styling.html" /><link rel="prev" title="Math Operations" href="math_operations.html" />
 
     <link rel="shortcut icon" href="_static/favicon.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>Constants and Unit Conversions - efficalc 1.1.0 documentation</title>
+        <title>Constants and Unit Conversions - efficalc 1.2.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -126,7 +126,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">efficalc 1.1.0 documentation</div></a>
+      <a href="index.html"><div class="brand">efficalc 1.2.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -152,7 +152,7 @@
     <img class="sidebar-logo" src="_static/efficalc.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">efficalc 1.1.0 documentation</span>
+  <span class="sidebar-brand-text">efficalc 1.2.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -368,7 +368,7 @@ <h2>Constants<a class="headerlink" href="#id1" title="Link to this heading">#</a
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=fc837d61"></script>
+</div><script src="_static/documentation_options.js?v=6efca38a"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/docs/examples.html b/docs/examples.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Testing Your Calculations" href="testing.html" />
 
     <link rel="shortcut icon" href="_static/favicon.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>Examples - efficalc 1.1.0 documentation</title>
+        <title>Examples - efficalc 1.2.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -126,7 +126,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">efficalc 1.1.0 documentation</div></a>
+      <a href="index.html"><div class="brand">efficalc 1.2.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -152,7 +152,7 @@
     <img class="sidebar-logo" src="_static/efficalc.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">efficalc 1.1.0 documentation</span>
+  <span class="sidebar-brand-text">efficalc 1.2.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -301,7 +301,7 @@ <h3>Steel Beam Moment Strength<a class="headerlink" href="#steel-beam-moment-str
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=fc837d61"></script>
+</div><script src="_static/documentation_options.js?v=6efca38a"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/docs/figures.html b/docs/figures.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Calculation Helpers" href="calculation_helpers.html" /><link rel="prev" title="Base Classes" href="base_classes.html" />
 
     <link rel="shortcut icon" href="_static/favicon.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>Figures in Calc Reports - efficalc 1.1.0 documentation</title>
+        <title>Figures in Calc Reports - efficalc 1.2.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -126,7 +126,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">efficalc 1.1.0 documentation</div></a>
+      <a href="index.html"><div class="brand">efficalc 1.2.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -152,7 +152,7 @@
     <img class="sidebar-logo" src="_static/efficalc.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">efficalc 1.1.0 documentation</span>
+  <span class="sidebar-brand-text">efficalc 1.2.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -458,7 +458,7 @@ <h3>Example<a class="headerlink" href="#id4" title="Link to this heading">#</a><
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=fc837d61"></script>
+</div><script src="_static/documentation_options.js?v=6efca38a"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -4,7 +4,7 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
 
-    <link rel="shortcut icon" href="_static/favicon.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --><title>Index - efficalc 1.1.0 documentation</title>
+    <link rel="shortcut icon" href="_static/favicon.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --><title>Index - efficalc 1.2.0 documentation</title>
 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -124,7 +124,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">efficalc 1.1.0 documentation</div></a>
+      <a href="index.html"><div class="brand">efficalc 1.2.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -150,7 +150,7 @@
     <img class="sidebar-logo" src="_static/efficalc.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">efficalc 1.1.0 documentation</span>
+  <span class="sidebar-brand-text">efficalc 1.2.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -319,17 +319,21 @@ <h2>E</h2>
           <li><a href="constants.html#module-efficalc.constants">module</a>
 </li>
         </ul></li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li>
     efficalc.unit_conversions
 
         <ul>
           <li><a href="constants.html#module-efficalc.unit_conversions">module</a>
 </li>
         </ul></li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="base_classes.html#efficalc.Calculation.estimate_display_length">estimate_display_length() (efficalc.Calculation method)</a>
+
+        <ul>
+          <li><a href="base_classes.html#efficalc.Symbolic.estimate_display_length">(efficalc.Symbolic method)</a>
 </li>
+        </ul></li>
         <li><a href="math_operations.html#efficalc.exp">exp() (in module efficalc)</a>
 </li>
     </ul></td>
@@ -388,6 +392,8 @@ <h2>G</h2>
           <li><a href="base_classes.html#efficalc.Comparison.get_value">(efficalc.Comparison method)</a>
 </li>
           <li><a href="base_classes.html#efficalc.Input.get_value">(efficalc.Input method)</a>
+</li>
+          <li><a href="base_classes.html#efficalc.Symbolic.get_value">(efficalc.Symbolic method)</a>
 </li>
         </ul></li>
     </ul></td>
@@ -525,14 +531,16 @@ <h2>R</h2>
 </li>
         <li><a href="calculation_helpers.html#efficalc.report_builder.ReportBuilder">ReportBuilder (class in efficalc.report_builder)</a>
 </li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="base_classes.html#efficalc.Calculation.result">result() (efficalc.Calculation method)</a>
 
         <ul>
           <li><a href="base_classes.html#efficalc.Comparison.result">(efficalc.Comparison method)</a>
+</li>
+          <li><a href="base_classes.html#efficalc.Symbolic.result">(efficalc.Symbolic method)</a>
 </li>
         </ul></li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="math_operations.html#efficalc.root">root() (in module efficalc)</a>
 </li>
     </ul></td>
@@ -559,16 +567,24 @@ <h2>S</h2>
 </li>
         <li><a href="math_operations.html#efficalc.sqrt">sqrt() (in module efficalc)</a>
 </li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="base_classes.html#efficalc.Calculation.str_result_with_description">str_result_with_description() (efficalc.Calculation method)</a>
+
+        <ul>
+          <li><a href="base_classes.html#efficalc.Symbolic.str_result_with_description">(efficalc.Symbolic method)</a>
 </li>
+        </ul></li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="base_classes.html#efficalc.Input.str_result_with_name">str_result_with_name() (efficalc.Input method)</a>
+</li>
+        <li><a href="base_classes.html#efficalc.Symbolic.str_result_with_unit">str_result_with_unit() (efficalc.Symbolic method)</a>
 </li>
         <li><a href="base_classes.html#efficalc.Calculation.str_substituted">str_substituted() (efficalc.Calculation method)</a>
 
         <ul>
           <li><a href="base_classes.html#efficalc.Comparison.str_substituted">(efficalc.Comparison method)</a>
+</li>
+          <li><a href="base_classes.html#efficalc.Symbolic.str_substituted">(efficalc.Symbolic method)</a>
 </li>
         </ul></li>
         <li><a href="base_classes.html#efficalc.Calculation.str_symbolic">str_symbolic() (efficalc.Calculation method)</a>
@@ -577,9 +593,13 @@ <h2>S</h2>
           <li><a href="base_classes.html#efficalc.Comparison.str_symbolic">(efficalc.Comparison method)</a>
 </li>
           <li><a href="base_classes.html#efficalc.ComparisonStatement.str_symbolic">(efficalc.ComparisonStatement method)</a>
+</li>
+          <li><a href="base_classes.html#efficalc.Symbolic.str_symbolic">(efficalc.Symbolic method)</a>
 </li>
         </ul></li>
         <li><a href="math_operations.html#efficalc.sub">sub() (in module efficalc)</a>
+</li>
+        <li><a href="base_classes.html#efficalc.Symbolic">Symbolic (class in efficalc)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -659,7 +679,7 @@ <h2>Z</h2>
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=fc837d61"></script>
+</div><script src="_static/documentation_options.js?v=6efca38a"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/docs/get_started.html b/docs/get_started.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Purpose and Background" href="purpose.html" /><link rel="prev" title="efficalc" href="index.html" />
 
     <link rel="shortcut icon" href="_static/favicon.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>Quickstart - efficalc 1.1.0 documentation</title>
+        <title>Quickstart - efficalc 1.2.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -126,7 +126,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">efficalc 1.1.0 documentation</div></a>
+      <a href="index.html"><div class="brand">efficalc 1.2.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -152,7 +152,7 @@
     <img class="sidebar-logo" src="_static/efficalc.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">efficalc 1.1.0 documentation</span>
+  <span class="sidebar-brand-text">efficalc 1.2.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -352,7 +352,7 @@ <h2>View Reports<a class="headerlink" href="#view-reports" title="Link to this h
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=fc837d61"></script>
+</div><script src="_static/documentation_options.js?v=6efca38a"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>