Support general arithmetic expressions (#30)

* updated configurations

* fixed typo

* added more info in error message

* added support for general arithmetic expression

* updated console calculator

* switch from if-else to match-case

* fix and skip mypy problems

* pre-commit autoupdate

* updated pyproject formatting

* fixed failure tests for updated types

* support negative numbers

* refactor to reduce code complexity

* added new test

* added new test for wrong sub-parser use

* formatted stub files with isort and black

* updated readme

* pre-commit autoupdate

* updated sphinx docs

* address PTC-W0063 detected by DeepSource

* address enum str mixin formatting breaking change

Ref. python/cpython#100458.

* rename function

* updated docstring

* split infix to postfix conversion

* skipped few lines from coverage

* changed module docstring

* removed unnecessary check

* avoided list index out of range

* improved error messages

* added more tests

* skip PY-R1000 detected by DeepSource

* fixed typo

* moved coverage skip to cover conditional block

* skipped coverage for safety block

* updated codecov configuration

Author: yarnabrina

.pre-commit-config.yaml

@@ -4,10 +4,16 @@ repos:
     hooks:
       - id: check-ast
       - id: check-case-conflict
+      - id: check-executables-have-shebangs
       - id: check-json
       - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
       - id: check-toml
       - id: check-yaml
+        args:
+          - --allow-multiple-documents
+      - id: detect-private-key
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: name-tests-test
@@ -92,14 +98,14 @@ repos:
         stages:
           - manual
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.333
+    rev: v1.1.334
     hooks:
       - id: pyright
         pass_filenames: false
         stages:
           - manual
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.3
+    rev: v0.1.4
     hooks:
       - id: ruff
         args:
@@ -146,7 +152,7 @@ repos:
           - src
         pass_filenames: false
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: 1.3.0
+    rev: 1.4.1
     hooks:
       - id: pyproject-fmt
   - repo: https://github.com/abravalheri/validate-pyproject
@@ -157,6 +163,12 @@ repos:
     rev: v2.2.6
     hooks:
       - id: codespell
+        additional_dependencies:
+          - tomli
+        args:
+          - --write-changes
+        stages:
+          - manual
 default_language_version:
   python: python3.10
 fail_fast: false

README.md

@@ -30,7 +30,7 @@
 - [x] ~~Host Documentation~~
 - [x] ~~Hypotheses Testing~~
 - [x] ~~Pydantic Validation~~
-- [ ] Support Expressions
+- [x] ~~Support Expressions~~
 - [ ] Bump Workflow
 
 ## Tools Used

codecov.yml

@@ -2,6 +2,9 @@ codecov:
   require_ci_to_pass: true
 coverage:
   status:
+    patch:
+      default:
+        target: 80%
     project:
       default:
         target: 80%

docs/source/package_name_to_import_with.rst

@@ -17,6 +17,7 @@ Submodules
 
    package_name_to_import_with.data_using_module
    package_name_to_import_with.garbage_collection_module
+   package_name_to_import_with.simplify
 
 Module contents
 ---------------

docs/source/package_name_to_import_with.simplify.rst

@@ -0,0 +1,7 @@
+package\_name\_to\_import\_with.simplify module
+===============================================
+
+.. automodule:: package_name_to_import_with.simplify
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyproject.toml

@@ -217,6 +217,7 @@ ignore-fully-untyped = true
 extend-immutable-calls = [
   "fastapi.Depends",
   "fastapi.Query",
+  "pydantic.Field",
 ]
 
 [tool.ruff.flake8-type-checking]
@@ -229,7 +230,9 @@ runtime-evaluated-base-classes = [
 ]
 
 [tool.ruff.pep8-naming]
-classmethod-decorators = ["pydantic.field_validator"]
+classmethod-decorators = [
+  "pydantic.field_validator",
+]
 
 [tool.ruff.per-file-ignores]
 "**/__init__.py" = [
@@ -238,9 +241,6 @@ classmethod-decorators = ["pydantic.field_validator"]
 "**/test_*.py" = [
   "S101",
 ]
-"docs/source/conf.py" = [
-  "INP001",
-]
 
 [tool.ruff.pycodestyle]
 max-doc-length = 99
@@ -261,9 +261,45 @@ atomic = true
 float_to_top = true
 line_length = 99
 remove_redundant_aliases = true
-src_paths = "src"
+src_paths = [
+  "src",
+]
 py_version = 310
 
+[tool.pylint.main]
+extension-pkg-allow-list = [
+  "pydantic",
+]
+fail-under = 8.5
+jobs = 0
+recursive = true
+
+[tool.pylint.basic]
+include-naming-hint = true
+
+[tool.pylint.format]
+max-line-length = 99
+
+[tool.pylint.logging]
+logging-format-style = "new"
+
+[tool.pylint."messages control"]
+enable = [
+  "all",
+]
+disable = [
+  "logging-fstring-interpolation",
+]
+
+[tool.pylint.reports]
+output-format = "colorized"
+
+[tool.docformatter]
+in-place = true
+recursive = true
+wrap-summaries = 99
+wrap-descriptions = 99
+
 [tool.pytest.ini_options]
 addopts = "--junit-xml=pytest_junit_report.xml --doctest-modules --doctest-ignore-import-errors --doctest-continue-on-failure"
 console_output_style = "count"
@@ -280,7 +316,7 @@ omit = [
 ]
 
 [tool.coverage.report]
-fail_under = 75
+fail_under = 85
 include = [
   "src/**/*.py",
 ]
@@ -323,47 +359,13 @@ ignore-init-module-imports = true
 remove-duplicate-keys = true
 remove-unused-variables = true
 
-[tool.docformatter]
-in-place = true
-recursive = true
-wrap-summaries = 99
-wrap-descriptions = 99
-
 [tool.interrogate]
-fail-under = 75
+fail-under = 85
 ignore-init-method = true
 
 [tool.pydocstyle]
 convention = "numpy"
 
-[tool.pylint.main]
-extension-pkg-allow-list = [
-  "pydantic",
-]
-fail-under = 7.5
-jobs = 0
-recursive = true
-
-[tool.pylint.basic]
-include-naming-hint = true
-
-[tool.pylint.format]
-max-line-length = 99
-
-[tool.pylint.logging]
-logging-format-style = "new"
-
-[tool.pylint."messages control"]
-enable = [
-  "all",
-]
-disable = [
-  "logging-fstring-interpolation",
-]
-
-[tool.pylint.reports]
-output-format = "colorized"
-
 [tool.pyright]
 include = [
   "src",

src/module_that_can_be_invoked_from_cli.py

@@ -1,5 +1,6 @@
 """Calculate arithmetic expressions from command line."""
 import argparse
+import enum
 import sys
 import typing
 
@@ -8,24 +9,71 @@
 import package_name_to_import_with
 
 
+@enum.unique
+class CalculatorType(str, enum.Enum):
+    """Define supported calculator types."""
+
+    BINARY = "binary"
+    GENERAL = "general"
+
+
+class BinaryInputs(pydantic.BaseModel):
+    """Define arguments for binary calculator."""
+
+    calculator_type: typing.Literal[CalculatorType.BINARY]
+    first_number: float
+    operator: package_name_to_import_with.calculator_sub_package.ArithmeticOperator
+    second_number: float
+
+
+class GeneralInputs(pydantic.BaseModel):
+    """Define arguments of general calculator."""
+
+    calculator_type: typing.Literal[CalculatorType.GENERAL]
+    expression: str
+
+
+class UserInputs(pydantic.BaseModel):
+    """Define sub-commands and arguments of CLI calculator."""
+
+    inputs: BinaryInputs | GeneralInputs = pydantic.Field(discriminator="calculator_type")
+
+
 @pydantic.validate_call(validate_return=True)
-def capture_user_inputs() -> dict[str, typing.Any]:
+def capture_user_inputs() -> UserInputs:
     """Capture user inputs for arithmetic expression.
 
     Returns
     -------
-    dict[str, typing.Any]
+    UserInputs
         captured user inputs
     """
     parser = argparse.ArgumentParser(description="calculator for console", add_help=True)
 
-    parser.add_argument("first_number", help="first number")
-    parser.add_argument("operator", help="arithmetic operator")
-    parser.add_argument("second_number", help="second number")
+    sub_parsers = parser.add_subparsers(
+        dest="calculator_type", help="types of arithmetic expressions"
+    )
+
+    binary_parser = sub_parsers.add_parser(
+        CalculatorType.BINARY.value, help="basic binary operations"
+    )
+    general_parser = sub_parsers.add_parser(
+        CalculatorType.GENERAL.value, help="standard simplification problems"
+    )
+
+    binary_parser.add_argument("first_number", type=float, help="first number")
+    binary_parser.add_argument(
+        "operator",
+        type=package_name_to_import_with.calculator_sub_package.ArithmeticOperator,
+        help="arithmetic operator",
+    )
+    binary_parser.add_argument("second_number", type=float, help="second number")
+
+    general_parser.add_argument("expression", type=str, help="infix expression")
 
     parsed_arguments, _ = parser.parse_known_args()
 
-    return vars(parsed_arguments)
+    return UserInputs.model_validate({"inputs": vars(parsed_arguments)})
 
 
 @pydantic.validate_call(validate_return=True)
@@ -34,9 +82,19 @@ def console_calculator() -> None:
     user_inputs = capture_user_inputs()
 
     try:
-        operation_result = package_name_to_import_with.calculate_results(
-            user_inputs["first_number"], user_inputs["operator"], user_inputs["second_number"]
-        )
+        match user_inputs.inputs.calculator_type:
+            case CalculatorType.BINARY:
+                operation_result = package_name_to_import_with.calculate_results(
+                    user_inputs.inputs.first_number,  # type: ignore[union-attr]
+                    user_inputs.inputs.operator,  # type: ignore[union-attr]
+                    user_inputs.inputs.second_number,  # type: ignore[union-attr]
+                )
+            case CalculatorType.GENERAL:
+                operation_result = package_name_to_import_with.solve_simplification(
+                    user_inputs.inputs.expression  # type: ignore[union-attr]
+                )
+            case _:  # pragma: no cover
+                operation_result = None
     except Exception as error:  # noqa: BLE001  # pylint: disable=broad-except
         sys.stderr.write(f"Error: {error}")
     else:

src/package_name_to_import_with/__init__.py

@@ -2,6 +2,7 @@
 from .calculator_sub_package import calculate_results
 from .data_using_module import METADATA
 from .garbage_collection_module import define_garbage_collection_decorator
+from .simplify import solve_simplification
 
-__all__ = ["calculate_results", "define_garbage_collection_decorator"]
+__all__ = ["calculate_results", "define_garbage_collection_decorator", "solve_simplification"]
 __version__: str = METADATA.Version

src/package_name_to_import_with/calculator_sub_package/tests/conftest.py

@@ -1,5 +1,4 @@
 """Define common inputs for unit tests."""
-
 import pytest
 
 from package_name_to_import_with.calculator_sub_package.wrapper_module import ArithmeticOperator
@@ -81,16 +80,12 @@ def expected_result(
     ValueError
         if ``operator`` not one of ``+``, ``-``, ``*``, ``/``
     """
-    if ArithmeticOperator(operator) == ArithmeticOperator.ADDITION:
-        return first_number + second_number
-
-    if ArithmeticOperator(operator) == ArithmeticOperator.SUBTRACTION:
-        return first_number - second_number
-
-    if ArithmeticOperator(operator) == ArithmeticOperator.MULTIPLICATION:
-        return first_number * second_number
-
-    if ArithmeticOperator(operator) == ArithmeticOperator.DIVISION:
-        return first_number / second_number
-
-    raise ValueError("Unexpected value of operation")
+    match operator:
+        case ArithmeticOperator.ADDITION:
+            return first_number + second_number
+        case ArithmeticOperator.SUBTRACTION:
+            return first_number - second_number
+        case ArithmeticOperator.MULTIPLICATION:
+            return first_number * second_number
+        case ArithmeticOperator.DIVISION:
+            return first_number / second_number

src/package_name_to_import_with/calculator_sub_package/tests/test_wrappers.py

@@ -1,4 +1,4 @@
-"""Define unit tests for user level functions."""
+"""Define unit tests for basic binary operations."""
 import math
 import typing