codeallyadvanced 1.1.0__tar.gz → 1.3.0__tar.gz

{codeallyadvanced-1.1.0/src/codeallyadvanced.egg-info → codeallyadvanced-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codeallyadvanced
-Version: 1.1.0
+Version: 1.3.0
 Summary: Humberto`s Common UI Stuff
 Author-email: "Humberto A. Sanchez II" <Humbert.A.Sanchez.II@gmail.com>
 Maintainer-email: "Humberto A. Sanchez II" <Humbert.A.Sanchez.II@gmail.com>
@@ -9,7 +9,7 @@ Project-URL: Repository, https://github.com/hasii2011/code-ally-advanced
 Keywords: pyut,python
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: codeallybasic>=1.1.0
+Requires-Dist: codeallybasic>=1.2.0
 Requires-Dist: wxPython~=4.2.1
 
 ![](https://github.com/hasii2011/code-ally-basic/blob/master/developer/agpl-license-web-badge-version-2-256x48.png "AGPL")
@@ -24,11 +24,11 @@ Common UI artifacts for various projects I am developing
 Written by <a href="mailto:email@humberto.a.sanchez.ii@gmail.com?subject=Hello Humberto">Humberto A. Sanchez II</a>  (C) 2023
 
 ## Note
-For all kind of problems, requests, enhancements, bug reports, etc.,
-please drop me an e-mail.
+For all kinds of problems, requests, enhancements, bug reports, etc.,
+drop me an e-mail.
 
 ## Developer Notes
-This project uses [buildlackey](https://github.com/hasii2011/buildlackey) for day to day development builds
+This project uses [buildlackey](https://github.com/hasii2011/buildlackey) for day-to-day development builds
 
 ---
 
@@ -42,11 +42,11 @@ I urge you to read about the
 [Give up GitHub](https://GiveUpGitHub.org) campaign from
 [the Software Freedom Conservancy](https://sfconservancy.org).
 
-While I do not advocate for all the issues listed there I do not like that
+While I do not advocate for all the issues listed there, I do not like that
 a company like Microsoft may profit from open source projects.
 
-I continue to use GitHub because it offers the services I need for free.  But, I continue
-to monitor their terms of service.
+I continue to use GitHub because it offers the services I need for free.  
+I continue to monitor their terms of service.
 
 Any use of this project's code by GitHub Copilot, past or present, is done
 without our permission.  We do not consent to GitHub's use of this project's

{codeallyadvanced-1.1.0 → codeallyadvanced-1.3.0}/README.md

@@ -10,11 +10,11 @@ Common UI artifacts for various projects I am developing
 Written by <a href="mailto:email@humberto.a.sanchez.ii@gmail.com?subject=Hello Humberto">Humberto A. Sanchez II</a>  (C) 2023
 
 ## Note
-For all kind of problems, requests, enhancements, bug reports, etc.,
-please drop me an e-mail.
+For all kinds of problems, requests, enhancements, bug reports, etc.,
+drop me an e-mail.
 
 ## Developer Notes
-This project uses [buildlackey](https://github.com/hasii2011/buildlackey) for day to day development builds
+This project uses [buildlackey](https://github.com/hasii2011/buildlackey) for day-to-day development builds
 
 ---
 
@@ -28,11 +28,11 @@ I urge you to read about the
 [Give up GitHub](https://GiveUpGitHub.org) campaign from
 [the Software Freedom Conservancy](https://sfconservancy.org).
 
-While I do not advocate for all the issues listed there I do not like that
+While I do not advocate for all the issues listed there, I do not like that
 a company like Microsoft may profit from open source projects.
 
-I continue to use GitHub because it offers the services I need for free.  But, I continue
-to monitor their terms of service.
+I continue to use GitHub because it offers the services I need for free.  
+I continue to monitor their terms of service.
 
 Any use of this project's code by GitHub Copilot, past or present, is done
 without our permission.  We do not consent to GitHub's use of this project's

{codeallyadvanced-1.1.0 → codeallyadvanced-1.3.0}/pyproject.toml

@@ -13,7 +13,7 @@ maintainers = [{name = 'Humberto A. Sanchez II', email = 'Humbert.A.Sanchez.II@g
 keywords = ['pyut', 'python',]
 
 dependencies = [
-  'codeallybasic>=1.1.0',
+  'codeallybasic>=1.2.0',
   'wxPython~=4.2.1'
 ]
 

codeallyadvanced-1.3.0/src/codeallyadvanced/_version.py

@@ -0,0 +1 @@
+__version__: str = '1.3.0'

codeallyadvanced-1.3.0/src/codeallyadvanced/ui/widgets/DialSelector.py

@@ -0,0 +1,192 @@
+from typing import Any
+from typing import Callable
+from typing import List
+
+from dataclasses import dataclass
+
+from math import ceil
+
+from logging import Logger
+from logging import getLogger
+from typing import cast
+
+from wx import ALIGN_LEFT
+from wx import ID_ANY
+from wx import StaticText
+
+from wx.lib.agw.knobctrl import EVT_KC_ANGLE_CHANGED
+from wx.lib.agw.knobctrl import KnobCtrl
+from wx.lib.agw.knobctrl import KnobCtrlEvent
+
+from wx.lib.sized_controls import SizedStaticBox
+
+FormatValueCallback = Callable[[Any], str]
+ValueChangeCallback = Callable[[Any], None]
+
+NO_FORMAT_CALLBACK:  FormatValueCallback = cast(FormatValueCallback, None)
+NO_VALUE_CALLBACK:   ValueChangeCallback = cast(ValueChangeCallback, None)
+
+
+@dataclass
+class DialSelectorParameters:
+    minValue:  int | float = 0
+    maxValue:  int | float = 0
+    dialLabel: str         = ''
+    formatValueCallback:  FormatValueCallback = NO_FORMAT_CALLBACK
+    valueChangedCallback: ValueChangeCallback = NO_VALUE_CALLBACK
+
+
+OPINIONATED_TICK_FREQUENCY: int = 10
+OPINIONATED_TICK_VALUE:     int = 10
+KNOB_CTRL_GRANULARITY:      int = 100
+
+
+class DialSelector(SizedStaticBox):
+    """
+    Using the Adapter pattern.  I don't care what PyBites says
+    The wrapped knob control reports 100 positions; We will put
+    tick marks (tags) every 10 positions and coerce the reported
+    values to align on those marks
+    """
+
+    def __init__(self, parent, parameters: DialSelectorParameters):
+
+        super().__init__(parent, label=parameters.dialLabel)
+        self.logger: Logger = getLogger(__name__)
+
+        self._parameters:    DialSelectorParameters = parameters
+
+        self._tickFrequency: int         = OPINIONATED_TICK_FREQUENCY
+        self._tickValue:     int | float = OPINIONATED_TICK_VALUE
+        self._value:         int | float = parameters.minValue
+
+        self.SetSizerType('vertical')
+        # noinspection PyUnresolvedReferences
+        self.SetSizerProps(expand=True, proportion=1)
+
+        self._knobCtrl: KnobCtrl = KnobCtrl(self, size=(100, 100))
+
+        self._knobCtrl.SetAngularRange(-45, 225)
+        self._knobCtrl.SetKnobRadius(4)
+        self._setTicksOnKnob()
+
+        self._knobTracker: StaticText = StaticText(parent=self, id=ID_ANY, label=f'{parameters.dialLabel}: 0', style=ALIGN_LEFT)
+
+        self._displayValue(value=parameters.minValue)
+
+        self.Bind(EVT_KC_ANGLE_CHANGED, self._onKnobChanged, self._knobCtrl)
+
+    @property
+    def tickFrequency(self) -> int | float:
+        return self._tickFrequency
+
+    @tickFrequency.setter
+    def tickFrequency(self, value: int):
+        """
+        The underlying control has a tick granularity of 100. Set a
+        value between 1 and 100
+
+        The underlying control computes the value of each tick
+
+        Args:
+            value: Indicates how to space out the tick marks
+        """
+        assert 1 <= value <= 100
+        self._tickFrequency = value
+        self._setTicksOnKnob()
+
+    @property
+    def tickValue(self) -> int | float:
+        return self._tickValue
+
+    @tickValue.setter
+    def tickValue(self, value: int | float):
+        self._tickValue = value
+        self._displayValue(value=value)
+
+    @property
+    def value(self) -> int | float:
+        """
+        The returned value is between the min/max values specified in the
+        dial range;  It is modulo the specified tick frequency.
+        Returns:  The current control value
+        """
+        return self._value
+
+    @value.setter
+    def value(self, newValue: int | float):
+
+        self._value = newValue
+
+        tickNumber: int = self._valueToTick(value=newValue)
+
+        self.logger.debug(f'{newValue=} {tickNumber=}')
+
+        self._knobCtrl.SetValue(tickNumber)
+        self._displayValue(newValue)
+
+    def _onKnobChanged(self, event: KnobCtrlEvent):
+
+        knobValue:        int = event.GetValue()
+        roundedKnobValue: int = self._alignKnobToTick(knobValue=knobValue)
+        self._knobCtrl.SetValue(roundedKnobValue)
+
+        realValue = self._calculateRealValue(roundedKnobValue=roundedKnobValue,
+                                             tickValue=self._tickValue,
+                                             tickFrequency=self._tickFrequency)
+
+        self.logger.debug(f'realValue={realValue:.2f}')
+        self._displayValue(value=realValue)
+
+        self._value = realValue
+
+        self._parameters.valueChangedCallback(self._value)
+
+        event.Skip(skip=True)
+
+    def _alignKnobToTick(self, knobValue: int):
+
+        # TODO: This will be moved to codeallybasic
+        # Including the unit tests
+        #
+        def roundUpToNearestTick(valueToRound, boundaryValue: int) -> int:
+            return int(ceil(valueToRound / boundaryValue)) * boundaryValue
+
+        roundToIncrement: int = KNOB_CTRL_GRANULARITY // self._tickFrequency
+
+        roundedKnobValue: int = roundUpToNearestTick(valueToRound=knobValue, boundaryValue=roundToIncrement)
+
+        self.logger.info(f'{knobValue=} {roundedKnobValue=}')
+
+        return roundedKnobValue
+
+    def _setTicksOnKnob(self):
+        assert self._parameters is not None, 'Developer Error'
+        assert self._tickFrequency != 0,    'Developer Error'
+        assert self._knobCtrl is not None,  'Developer Error'
+
+        integerList:   List[int] = list(range(1, self._tickFrequency, 1))
+
+        self.logger.debug(f'{integerList=}')
+        self._knobCtrl.SetTags(integerList)
+
+    def _displayValue(self, value: int | float):
+
+        label: str = self._parameters.formatValueCallback(value)
+
+        self._knobTracker.SetLabel(label)
+        self._knobTracker.Refresh()
+
+    def _calculateRealValue(self, roundedKnobValue: int, tickValue: int | float, tickFrequency: int):
+
+        tickPosition: int = int((roundedKnobValue / KNOB_CTRL_GRANULARITY) * tickFrequency)
+        self.logger.debug(f'{tickPosition=}')
+        realValue    = tickValue * tickPosition
+
+        return realValue
+
+    def _valueToTick(self, value: int | float) -> int:
+
+        tickNumber: int = int(value // self._tickValue)
+
+        return tickNumber

{codeallyadvanced-1.1.0 → codeallyadvanced-1.3.0}/src/codeallyadvanced/ui/widgets/DualSpinnerControl.py

@@ -98,6 +98,7 @@ class DualSpinnerControl(SizedStaticBox):
         self._spinner1.SetValue(spinnerValues.value1)
         self.dscLogger.info(f'range: {self._spinner0.GetRange()} - {self._spinner0.GetValue()=} {self._spinner1.GetValue()=}')
 
+    # noinspection PyTypeChecker
     spinnerValues = property(fset=_setSpinnerValues, doc='Write only property to initialize spinner values')
 
     def enableControls(self, value: bool):

codeallyadvanced-1.3.0/src/codeallyadvanced/ui/widgets/MinMaxControl.py

@@ -0,0 +1,73 @@
+
+from typing import Callable
+from typing import List
+
+from logging import Logger
+from logging import getLogger
+
+from dataclasses import dataclass
+
+from wx.lib.sized_controls import SizedPanel
+
+from codeallyadvanced.ui.widgets.DualSpinnerControl import DualSpinnerControl
+from codeallyadvanced.ui.widgets.DualSpinnerControl import SpinnerValues
+
+
+@dataclass
+class MinMax:
+    minValue: int = 0
+    maxValue: int = 0
+
+    @classmethod
+    def deSerialize(cls, value: str) -> 'MinMax':
+
+        minMax: MinMax = MinMax()
+
+        values: List[str] = value.split(sep=',')
+
+        assert len(values) == 2, 'Incorrectly formatted min/max values'
+
+        try:
+            minMax.minValue = int(values[0])
+            minMax.maxValue = int(values[1])
+        except ValueError as ve:
+            print(f'MinMax - {ve}.')
+            minMax.minValue = 0
+            minMax.maxValue = 0
+
+        return minMax
+
+    def __str__(self):
+        return f'{self.minValue},{self.maxValue}'
+
+    def __repr__(self):
+        return self.__str__()
+
+
+class MinMaxControl(DualSpinnerControl):
+    def __init__(self, sizedPanel: SizedPanel, displayText: str,
+                 valueChangedCallback: Callable,
+                 minValue: int, maxValue: int,
+                 setControlsSize: bool = True):
+
+        self.logger: Logger = getLogger(__name__)
+
+        self._valuesChangedCallback: Callable = valueChangedCallback
+        self._minMax:                MinMax   = MinMax()
+
+        super().__init__(sizedPanel, displayText, self._onSpinValueChangedCallback, minValue, maxValue, setControlsSize)
+
+    def _setMinMax(self, newValue: MinMax):
+        self._position = newValue
+        self.spinnerValues = SpinnerValues(value0=newValue.minValue, value1=newValue.maxValue)
+
+    # noinspection PyTypeChecker
+    minMax = property(fdel=None, fget=None, fset=_setMinMax, doc='Write only property to set values')
+
+    def _onSpinValueChangedCallback(self, spinnerValues: SpinnerValues):
+
+        self.logger.info(f'{spinnerValues}')
+        self._minMax.minValue = spinnerValues.value0
+        self._minMax.maxValue = spinnerValues.value1
+
+        self._valuesChangedCallback(self._minMax)

{codeallyadvanced-1.1.0 → codeallyadvanced-1.3.0}/src/codeallyadvanced/ui/widgets/PositionControl.py

@@ -14,7 +14,7 @@ from codeallyadvanced.ui.widgets.DualSpinnerControl import SpinnerValues
 
 class PositionControl(DualSpinnerControl):
     """
-    A facade around the basic dual spinner control;   Essentially
+    A facade around the basic dual-spinner control;   Essentially
         * Converts the spinner values to and from the Position type;
         * Handles the spinner callback
         * Forwards the spinner values as Position values
@@ -47,7 +47,8 @@ class PositionControl(DualSpinnerControl):
         self._position = newValue
         self.spinnerValues = SpinnerValues(value0=newValue.x, value1=newValue.y)
 
-    position = property(fset=_setPosition, doc='Write only property to set values')
+    # noinspection PyTypeChecker
+    position = property(fdel=None, fget=None, fset=_setPosition, doc='Write only property to set values')
 
     def _onSpinValueChangedCallback(self, spinnerValues: SpinnerValues):
         self.logger.info(f'{spinnerValues}')

{codeallyadvanced-1.1.0 → codeallyadvanced-1.3.0/src/codeallyadvanced.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codeallyadvanced
-Version: 1.1.0
+Version: 1.3.0
 Summary: Humberto`s Common UI Stuff
 Author-email: "Humberto A. Sanchez II" <Humbert.A.Sanchez.II@gmail.com>
 Maintainer-email: "Humberto A. Sanchez II" <Humbert.A.Sanchez.II@gmail.com>
@@ -9,7 +9,7 @@ Project-URL: Repository, https://github.com/hasii2011/code-ally-advanced
 Keywords: pyut,python
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: codeallybasic>=1.1.0
+Requires-Dist: codeallybasic>=1.2.0
 Requires-Dist: wxPython~=4.2.1
 
 ![](https://github.com/hasii2011/code-ally-basic/blob/master/developer/agpl-license-web-badge-version-2-256x48.png "AGPL")
@@ -24,11 +24,11 @@ Common UI artifacts for various projects I am developing
 Written by <a href="mailto:email@humberto.a.sanchez.ii@gmail.com?subject=Hello Humberto">Humberto A. Sanchez II</a>  (C) 2023
 
 ## Note
-For all kind of problems, requests, enhancements, bug reports, etc.,
-please drop me an e-mail.
+For all kinds of problems, requests, enhancements, bug reports, etc.,
+drop me an e-mail.
 
 ## Developer Notes
-This project uses [buildlackey](https://github.com/hasii2011/buildlackey) for day to day development builds
+This project uses [buildlackey](https://github.com/hasii2011/buildlackey) for day-to-day development builds
 
 ---
 
@@ -42,11 +42,11 @@ I urge you to read about the
 [Give up GitHub](https://GiveUpGitHub.org) campaign from
 [the Software Freedom Conservancy](https://sfconservancy.org).
 
-While I do not advocate for all the issues listed there I do not like that
+While I do not advocate for all the issues listed there, I do not like that
 a company like Microsoft may profit from open source projects.
 
-I continue to use GitHub because it offers the services I need for free.  But, I continue
-to monitor their terms of service.
+I continue to use GitHub because it offers the services I need for free.  
+I continue to monitor their terms of service.
 
 Any use of this project's code by GitHub Copilot, past or present, is done
 without our permission.  We do not consent to GitHub's use of this project's

{codeallyadvanced-1.1.0 → codeallyadvanced-1.3.0}/src/codeallyadvanced.egg-info/SOURCES.txt

@@ -73,9 +73,11 @@ src/codeallyadvanced/ui/Common.py
 src/codeallyadvanced/ui/UnitTestBaseW.py
 src/codeallyadvanced/ui/__init__.py
 src/codeallyadvanced/ui/py.typed
+src/codeallyadvanced/ui/widgets/DialSelector.py
 src/codeallyadvanced/ui/widgets/DimensionsControl.py
 src/codeallyadvanced/ui/widgets/DirectionEnum.py
 src/codeallyadvanced/ui/widgets/DualSpinnerControl.py
+src/codeallyadvanced/ui/widgets/MinMaxControl.py
 src/codeallyadvanced/ui/widgets/PositionControl.py
 src/codeallyadvanced/ui/widgets/__init__.py
 src/codeallyadvanced/ui/widgets/py.typed

codeallyadvanced-1.3.0/src/codeallyadvanced.egg-info/requires.txt

@@ -0,0 +1,2 @@
+codeallybasic>=1.2.0
+wxPython~=4.2.1

codeallyadvanced-1.1.0/src/codeallyadvanced/_version.py

@@ -1 +0,0 @@
-__version__: str = '1.1.0'

codeallyadvanced-1.1.0/src/codeallyadvanced.egg-info/requires.txt

@@ -1,2 +0,0 @@
-codeallybasic>=1.1.0
-wxPython~=4.2.1