qnty 0.0.2__py3-none-any.whl → 0.0.4__py3-none-any.whl

qnty/variable.py

@@ -10,7 +10,8 @@ from __future__ import annotations
 
 from typing import Generic, Self, TypeVar
 
-from .dimension import AREA, DIMENSIONLESS, ENERGY, FORCE, LENGTH, PRESSURE, VOLUME, DimensionSignature
+from .dimension import AREA, DIMENSIONLESS, FORCE, LENGTH, PRESSURE, VOLUME, DimensionSignature
+from .dimension import ENERGY_HEAT_WORK as ENERGY
 from .unit import UnitConstant, UnitDefinition, registry
 from .units import DimensionlessUnits, LengthUnits, PressureUnits
 

qnty/variable_types/base.py

@@ -0,0 +1,58 @@
+"""
+Base Variable Module Definition
+===============================
+
+Provides abstract base class for variable modules and registration functionality.
+"""
+
+from abc import ABC, abstractmethod
+from typing import Any
+
+
+class VariableModule(ABC):
+    """Abstract base class for variable modules."""
+    
+    @abstractmethod
+    def get_variable_class(self) -> type[Any]:
+        """Return the variable class for this module."""
+        pass
+    
+    @abstractmethod
+    def get_setter_class(self) -> type[Any]:
+        """Return the setter class for this module."""
+        pass
+    
+    @abstractmethod
+    def get_expected_dimension(self) -> Any:
+        """Return the expected dimension for this variable type."""
+        pass
+    
+    def register_to_registry(self, variable_registry):
+        """Register this variable module to the given registry."""
+        variable_registry.register_module(
+            self.get_expected_dimension(),
+            self.get_variable_class(),
+            self.get_setter_class()
+        )
+
+
+class VariableRegistry:
+    """Registry for variable modules."""
+    
+    def __init__(self):
+        self._modules = {}
+    
+    def register_module(self, dimension, variable_class, setter_class):
+        """Register a variable module."""
+        self._modules[dimension] = {
+            'variable_class': variable_class,
+            'setter_class': setter_class
+        }
+    
+    def get_variable_class(self, dimension):
+        """Get variable class for a dimension."""
+        return self._modules.get(dimension, {}).get('variable_class')
+    
+    def get_setter_class(self, dimension):
+        """Get setter class for a dimension."""
+        return self._modules.get(dimension, {}).get('setter_class')

qnty/variable_types/expression_variable.py

@@ -0,0 +1,68 @@
+"""
+Expression Variable Base Class
+==============================
+
+Base class that extends TypeSafeVariable with mathematical expression
+and equation capabilities.
+"""
+
+from __future__ import annotations
+
+from ..equation import Equation
+from ..expression import Expression, wrap_operand
+from ..variable import FastQuantity, TypeSafeVariable
+
+
+class ExpressionVariable(TypeSafeVariable):
+    """
+    TypeSafeVariable extended with expression and equation capabilities.
+    
+    This adds mathematical operations that create expressions and equations,
+    keeping the base TypeSafeVariable free of these dependencies.
+    """
+    
+    def equals(self, expression: Expression | TypeSafeVariable | FastQuantity | int | float):
+        """Create an equation: self = expression."""
+        # Wrap the expression in proper Expression type
+        rhs_expr = wrap_operand(expression)
+        return Equation(f"{self.name}_eq", self, rhs_expr)
+    
+    def __add__(self, other: TypeSafeVariable | FastQuantity | int | float) -> Expression:
+        """Add this variable to another operand, returning an Expression."""
+        return wrap_operand(self) + wrap_operand(other)
+
+    def __radd__(self, other: FastQuantity | int | float) -> Expression:
+        """Reverse add for this variable."""
+        return wrap_operand(other) + wrap_operand(self)
+    
+    def __sub__(self, other: TypeSafeVariable | FastQuantity | int | float) -> Expression:
+        """Subtract another operand from this variable, returning an Expression."""
+        return wrap_operand(self) - wrap_operand(other)
+    
+    def __rsub__(self, other: FastQuantity | int | float) -> Expression:
+        """Reverse subtract for this variable."""
+        return wrap_operand(other) - wrap_operand(self)
+    
+    def __mul__(self, other: TypeSafeVariable | FastQuantity | int | float) -> Expression:
+        """Multiply this variable by another operand, returning an Expression."""
+        return wrap_operand(self) * wrap_operand(other)
+    
+    def __rmul__(self, other: FastQuantity | int | float) -> Expression:
+        """Reverse multiply for this variable."""
+        return wrap_operand(other) * wrap_operand(self)
+    
+    def __truediv__(self, other: TypeSafeVariable | FastQuantity | int | float) -> Expression:
+        """Divide this variable by another operand, returning an Expression."""
+        return wrap_operand(self) / wrap_operand(other)
+
+    def __rtruediv__(self, other: FastQuantity | int | float) -> Expression:
+        """Reverse divide for this variable."""
+        return wrap_operand(other) / wrap_operand(self)
+    
+    def __pow__(self, other: TypeSafeVariable | FastQuantity | int | float) -> Expression:
+        """Raise this variable to a power, returning an Expression."""
+        return wrap_operand(self) ** wrap_operand(other)
+
+    def __rpow__(self, other: FastQuantity | int | float) -> Expression:
+        """Reverse power for this variable."""
+        return wrap_operand(other) ** wrap_operand(self)

qnty/variable_types/typed_variable.py

@@ -0,0 +1,92 @@
+"""
+Typed Variable Base Class
+=========================
+
+Base class that provides common constructor logic for all typed variables,
+handling both the original syntax and the new value/unit/name syntax.
+"""
+
+from ..dimension import DimensionSignature
+from ..variable import TypeSafeSetter
+from .expression_variable import ExpressionVariable
+
+
+class TypedVariable(ExpressionVariable):
+    """
+    Base class for typed variables with common constructor logic.
+    
+    Subclasses need to define:
+    - _setter_class: The setter class to use
+    - _expected_dimension: The expected dimension
+    - _default_unit_property: The default unit property name for fallback
+    """
+    
+    _setter_class: type[TypeSafeSetter] | None = None
+    _expected_dimension: DimensionSignature | None = None
+    _default_unit_property: str | None = None
+    
+    def __init__(self, *args, is_known: bool = True):
+        """
+        Flexible constructor supporting multiple syntaxes.
+        
+        Single argument: TypedVariable("name")
+        Three arguments: TypedVariable(value, "unit", "name")
+        Two arguments (Dimensionless only): TypedVariable(value, "name")
+        """
+        if self._setter_class is None or self._expected_dimension is None:
+            raise NotImplementedError("Subclass must define _setter_class and _expected_dimension")
+        
+        # Handle different argument patterns
+        if len(args) == 1:
+            # Original syntax: Variable("name")
+            super().__init__(args[0], self._expected_dimension, is_known=is_known)
+            
+        elif len(args) == 2 and self.__class__.__name__ == 'Dimensionless':
+            # Special case for Dimensionless: (value, "name")
+            value, name = args
+            super().__init__(name, self._expected_dimension, is_known=is_known)
+            setter = self._setter_class(self, value)
+            # For DimensionlessSetter, use the dimensionless property
+            # Type ignore since we know DimensionlessSetter has this property
+            getattr(setter, 'dimensionless', None)  # type: ignore
+            
+        elif len(args) == 3:
+            # New syntax: Variable(value, "unit", "name")
+            # But Dimensionless doesn't support this pattern
+            if self.__class__.__name__ == 'Dimensionless':
+                raise ValueError(f"{self.__class__.__name__} expects either 1 argument (name) or 2 arguments (value, name), got {len(args)}")
+            
+            value, unit, name = args
+            super().__init__(name, self._expected_dimension, is_known=is_known)
+            
+            # Auto-set the value with the specified unit
+            setter = self._setter_class(self, value)
+            
+            # Handle special unit aliases
+            if unit == "in":  # Handle Python reserved word
+                unit = "inchs"  # Match the actual property name
+            elif unit == "inches":  # Handle common plural form
+                unit = "inchs"  # Match the actual property name
+            
+            # Try to find the unit property on the setter
+            if hasattr(setter, unit):
+                getattr(setter, unit)
+            elif hasattr(setter, unit + 's'):  # Handle singular/plural
+                getattr(setter, unit + 's')
+            elif self._default_unit_property and hasattr(setter, self._default_unit_property):
+                # Fall back to default unit
+                getattr(setter, self._default_unit_property)
+            else:
+                # Last resort - try to find any valid unit property
+                # This helps with forward compatibility
+                unit_properties = [attr for attr in dir(setter)
+                                 if not attr.startswith('_') and attr != 'value' and attr != 'variable']
+                if unit_properties:
+                    getattr(setter, unit_properties[0])
+                    
+        else:
+            # More specific error messages matching test expectations
+            if self.__class__.__name__ == 'Dimensionless':
+                raise ValueError(f"{self.__class__.__name__} expects either 1 argument (name) or 2 arguments (value, name), got {len(args)}")
+            else:
+                raise ValueError(f"{self.__class__.__name__} expects either 1 argument (name) or 3 arguments (value, unit, name), got {len(args)}")