Add typing

Author: oscargus

.github/workflows/test.yml

@@ -12,8 +12,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
-        mpl-version: ["3.7", "3.8", "latest"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        mpl-version: ["3.9", "3.10", "latest"]
     steps:
       - name: Checkout
         uses: actions/checkout@v4

changelog.rst

@@ -22,6 +22,7 @@ Added
 - :func:`mplsignal.scipyplot.freqz_tristacked` for plotting magnitude, phase, and group
   delay in a single plot.
 - BREAKING: argument *align_ylabels* to all ``freq*``-plots which is ``True`` by default.
+- Initial typing information.
 
 Changed
 ^^^^^^^
@@ -31,6 +32,12 @@ Changed
 - BREAKING: All functions in :mod:`mplsignal.scipyplot` now use a constrained layout. This
   will in general make the plot clearer, although at the expense of margin.
 
+Fixed
+^^^^^
+
+- ``freq_unit`` was not propagated properly in all ``freq_plots.zfreq*`` functions and
+  ``style``-combinations.
+
 [0.2.0] - 2023-03-05
 --------------------
 

lib/mplsignal/freq_plots.py

@@ -11,6 +11,8 @@
     "freqz_zpk",
     "freqz_fir",
 ]
+from typing import Literal
+
 import matplotlib.pyplot as plt
 import numpy as np
 from mplsignal import _api, _utils
@@ -28,18 +30,20 @@ def freqz(
     den=None,
     zeros=None,
     poles=None,
-    gain=1.0,
+    gain: float = 1.0,
     w=None,
-    freq_unit='rad',
-    phase_unit='rad',
+    freq_unit: Literal['rad', 'deg', 'norm', 'fs', 'normfs'] = 'rad',
+    phase_unit: Literal['rad', 'deg'] = 'rad',
     ax=None,
-    style='stacked',
-    magnitude_scale='log',
-    frequency_scale='linear',
-    whole=False,
-    include_nyquist=False,
-    fs=2 * np.pi,
-    align_ylabels=True,
+    style: Literal[
+        'stacked', 'twin', 'magnitude', 'phase', 'group_delay', 'tristacked'
+    ] = 'stacked',
+    magnitude_scale: Literal['log', 'linear'] = 'log',
+    frequency_scale: Literal['log', 'linear'] = 'linear',
+    whole: bool = False,
+    include_nyquist: bool = False,
+    fs: float = 2 * np.pi,
+    align_ylabels: bool = True,
     **kwargs,
 ):
     """
@@ -225,6 +229,7 @@ def _plot_h(
             xmax=maxx,
             xlabel=(freqlabel if style == 'twin' else None),
             ylabel=maglabel,
+            freq_unit=freq_unit,
             frequency_scale=frequency_scale,
             magnitude_scale=magnitude_scale,
             fs=fs,
@@ -245,6 +250,7 @@ def _plot_h(
             xmin=minx,
             xmax=maxx,
             phase_unit=phase_unit,
+            freq_unit=freq_unit,
             ylabel=phaselabel,
             xlabel=(freqlabel if style == 'stacked' else None),
             fs=fs,

lib/mplsignal/plane_plots.py

@@ -12,6 +12,7 @@
 ]
 
 import math
+from typing import Optional
 
 import adjustText
 import matplotlib.pyplot as plt
@@ -23,16 +24,16 @@ def zplane(
     poles=None,
     ax=None,
     adjust=1,
-    spinelinewidth=0.2,
+    spinelinewidth: float = 0.2,
     spinecolor='black',
     zeromarker='o',
     polemarker='x',
-    unitcircle=True,
+    unitcircle: bool = True,
     markercolor=None,
     zerofillstyle='none',
     polefillstyle='none',
-    reallabel=None,
-    imaglabel=None,
+    reallabel: Optional[str] = None,
+    imaglabel: Optional[str] = None,
     zero_props=None,
     pole_props=None,
     multiplicity_props=None,

lib/mplsignal/ticker.py

@@ -7,6 +7,7 @@
 """
 import math
 from fractions import Fraction
+from typing import Optional
 
 from matplotlib.ticker import Formatter, Locator, MaxNLocator
 
@@ -24,15 +25,15 @@ class FactorLocator(Locator):
 
     Parameters
     ----------
-    factor : float
+    factor : float, default: 1.0
         The factor to extract.
-    nbins : int
+    nbins : int, optional
         Number of bins to aim for, see :class:`~matplotlib.tickers.MaxNLocator`.
     **kwargs
         Additional arguments passed to :class:`~matplotlib.tickers.MaxNLocator`.
     """
 
-    def __init__(self, factor=1.0, nbins=None, **kwargs):
+    def __init__(self, factor: float = 1.0, nbins: Optional[int] = None, **kwargs):
         """
         Locator for finding multiples of *factor*.
         """
@@ -65,18 +66,18 @@ class PiLocator(FactorLocator):
 
     Parameters
     ----------
-    nbins : int
+    nbins : int, optional
         Number of bins to aim for, see :class:`~matplotlib.tickers.MaxNLocator`.
     """
 
-    def __init__(self, nbins=None, **kwargs):
+    def __init__(self, nbins: Optional[int] = None, **kwargs):
         super().__init__(factor=math.pi, nbins=nbins, **kwargs)
 
 
 class SampleFrequencyLocator(FactorLocator):
     """Locator for finding multiples of sample frequency."""
 
-    def __init__(self, nbins=None, fs=1.0, **kwargs):
+    def __init__(self, nbins: Optional[int] = None, fs: float = 1.0, **kwargs):
         super().__init__(factor=fs / (2 * math.pi), nbins=nbins, **kwargs)
 
 
@@ -86,11 +87,11 @@ class DegreeLocator(MaxNLocator):
 
     Parameters
     ----------
-    nbins : int
+    nbins : int, optional
         Number of bins to aim for, see :class:`~matplotlib.tickers.MaxNLocator`.
     """
 
-    def __init__(self, nbins=None, **kwargs):
+    def __init__(self, nbins: Optional[int] = None, **kwargs):
         steps = kwargs.pop('steps', [1, 1.5, 2, 3, 5, 6, 10])
         if nbins is None:
             nbins = 'auto'
@@ -121,7 +122,12 @@ class FactorFormatter(Formatter):
     locs = []
 
     def __init__(
-        self, digits=3, factor=1.0, name="constant", name_on_all_numbers=False, **kwargs
+        self,
+        digits: int = 3,
+        factor: float = 1.0,
+        name: str = "constant",
+        name_on_all_numbers: bool = False,
+        **kwargs,
     ):
         self._digits = digits
         self._factor = factor
@@ -164,7 +170,7 @@ class PiFormatter(FactorFormatter):
         Cannot include *factor* and *name*.
     """
 
-    def __init__(self, digits=3, **kwargs):
+    def __init__(self, digits: int = 3, **kwargs):
         super().__init__(digits=digits, factor=math.pi, name=r"\pi", **kwargs)
 
 
@@ -183,7 +189,7 @@ class SampleFrequencyFormatter(FactorFormatter):
         Cannot include *factor* and *name*.
     """
 
-    def __init__(self, digits=3, fs=1.0, **kwargs):
+    def __init__(self, digits: int = 3, fs: float = 1.0, **kwargs):
         super().__init__(
             digits=digits, factor=fs / (2 * math.pi), name=r"f_s", **kwargs
         )
@@ -204,7 +210,7 @@ class DegreeFormatter(FactorFormatter):
         Cannot include *factor*, *name*, and *only_name_when_one*.
     """
 
-    def __init__(self, digits=3, **kwargs):
+    def __init__(self, digits: int = 3, **kwargs):
         super().__init__(
             digits=digits,
             factor=1,
@@ -233,7 +239,7 @@ class PiRationalFormatter(Formatter):
     # individual ones
     locs = []
 
-    def __init__(self, digits=3, pi_always_in_numerator=True, **kwargs):
+    def __init__(self, digits: int = 3, pi_always_in_numerator: bool = True, **kwargs):
         self._digits = digits
         self._pi_always_in_numerator = pi_always_in_numerator
         super().__init__(**kwargs)

pyproject.toml

@@ -1,53 +1,40 @@
 [project]
 name = "mplsignal"
 description = "Matplotlib extension for signal processing-related plots"
-authors = [
-{name = "Oscar Gustafsson", email = "oscar.gustafsson@gmail.com"}
-]
-requires-python = ">=3.8"
-license = {file = "LICENSE"}
+authors = [{ name = "Oscar Gustafsson", email = "oscar.gustafsson@gmail.com" }]
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
 readme = "README.md"
-dynamic = [
-   "version"
-]
-dependencies = [
-    "matplotlib",
-    "adjustText"
-    ]
-
+dynamic = ["version"]
+dependencies = ["matplotlib>=3.9", "adjustText"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Framework :: Matplotlib",
-    "Intended Audience :: Developers",
-    "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: BSD License",
-    "Programming Language :: Python",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    'Topic :: Scientific/Engineering :: Visualization',
+  "Development Status :: 3 - Alpha",
+  "Framework :: Matplotlib",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: BSD License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  'Topic :: Scientific/Engineering :: Visualization',
 ]
 
 [project.optional-dependencies]
-test = [
-     "black",
-     "pytest",
-     "pytest-mpl",
-     "pytest-cov"
-     ]
+test = ["black", "pytest", "pytest-mpl", "pytest-cov"]
 doc = [
-     "sphinx",
-     "numpydoc",
-     "sphinx_rtd_theme",
-     "sphinx-copybutton",
-     "sphinx-autobuild",
-     "sphinx_gallery>=0.8.2",
-     "autoapi",
-     "furo",
-     "scipy"
-     ]
+  "sphinx",
+  "numpydoc",
+  "sphinx_rtd_theme",
+  "sphinx-copybutton",
+  "sphinx-autobuild",
+  "sphinx_gallery>=0.8.2",
+  "autoapi",
+  "furo",
+  "scipy"
+]
 
 [project.urls]
 Homepage = "https://github.com/oscargus/mplsignal"
@@ -79,9 +66,7 @@ skip-string-normalization = true
 line-length = 88
 
 [tool.pytest.ini_options]
-testpaths = [
-    "mplsignal/tests"
-]
+testpaths = ["mplsignal/tests"]
 
 [tool.isort]
 profile = "black"