Add fixes suggested by ruff

Author: jrsmith3

doc/conf.py

@@ -19,9 +19,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'ibei'
-copyright = '2022, Joshua Ryan Smith'
-author = 'Joshua Ryan Smith'
+project = "ibei"
+copyright = "2022, Joshua Ryan Smith"
+author = "Joshua Ryan Smith"
 version = ibei.__version__
 
 
@@ -30,22 +30,17 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.napoleon',
-    'sphinxcontrib.bibtex'
-]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.mathjax", "sphinx.ext.napoleon", "sphinxcontrib.bibtex"]
 
 # Configuration for `autodoc`.
 autodoc_member_order = "bysource"
 
 
 # Configuration for `sphinxcontrib-bibtex`.
-bibtex_bibfiles = ['bib.bib']
+bibtex_bibfiles = ["bib.bib"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -58,10 +53,10 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]

src/ibei/models.py

@@ -27,7 +27,7 @@ def _int_converter(value):
         try:
             int(value)
         except ValueError as ex:
-            raise TypeError("Argument must be coercible to type int.") from ex  #noqa: TRY003, EM101
+            raise TypeError("Argument must be coercible to type int.") from ex  # noqa: TRY003, EM101
 
     elif int(value) != value:
         # I have to do some validation in this converter because if I were
@@ -39,14 +39,14 @@ def _int_converter(value):
         #
         # I'd not be able to catch this case because the attribute
         # would be assigned to the possibly truncated value.
-        raise TypeError("Argument must be coercible to type int without truncation.")  #noqa: TRY003, EM101
+        raise TypeError("Argument must be coercible to type int without truncation.")  # noqa: TRY003, EM101
 
     return int(value)
 
 
-def _validate_is_scalar(instance, attribute, value):  #noqa: ARG001
+def _validate_is_scalar(instance, attribute, value):  # noqa: ARG001
     if not value.isscalar:
-        raise TypeError("Attributes must be scalar")  #noqa: TRY003, EM101
+        raise TypeError("Attributes must be scalar")  # noqa: TRY003, EM101
 
 
 @attrs.frozen
@@ -114,40 +114,39 @@ class BEI:
     ----------
     .. [1] https://ibei.readthedocs.io/
     """
+
     order: int = attrs.field(
-            converter=_int_converter,
-        )
+        converter=_int_converter,
+    )
     energy_bound: float | astropy.units.Quantity[astropy.units.eV] = attrs.field(
-            converter=functools.partial(astropy.units.Quantity, unit=astropy.units.eV),
-            validator=[
-                _validate_is_scalar,
-                attrs.validators.ge(0),
-            ]
-        )
+        converter=functools.partial(astropy.units.Quantity, unit=astropy.units.eV),
+        validator=[
+            _validate_is_scalar,
+            attrs.validators.ge(0),
+        ],
+    )
     temperature: float | astropy.units.Quantity[astropy.units.K] = attrs.field(
-            converter=_temperature_converter,
-            validator=[
-                _validate_is_scalar,
-                attrs.validators.gt(0),
-            ]
-        )
+        converter=_temperature_converter,
+        validator=[
+            _validate_is_scalar,
+            attrs.validators.gt(0),
+        ],
+    )
     chemical_potential: float | astropy.units.Quantity[astropy.units.eV] = attrs.field(
-            default=0.,
-            converter=functools.partial(astropy.units.Quantity, unit=astropy.units.eV),
-            validator=[
-                _validate_is_scalar,
-                attrs.validators.ge(0),
-            ]
-        )
-
+        default=0.0,
+        converter=functools.partial(astropy.units.Quantity, unit=astropy.units.eV),
+        validator=[
+            _validate_is_scalar,
+            attrs.validators.ge(0),
+        ],
+    )
 
     def lower(self) -> astropy.units.Quantity:
         """
         Lower-incomplete Bose-Einstein integral.
         """
         return self.full() - self.upper()
 
-
     def upper(self) -> astropy.units.Quantity:
         """
         Upper-incomplete Bose-Einstein integral.
@@ -181,7 +180,6 @@ def upper(self) -> astropy.units.Quantity:
 
         return bei
 
-
     def full(self) -> astropy.units.Quantity:
         """
         Full Bose-Einstein integral.
@@ -197,7 +195,6 @@ def full(self) -> astropy.units.Quantity:
 
         return bei
 
-
     def photon_flux(self) -> astropy.units.Quantity[astropy.units.Unit("1/(m2 s)")]:
         """
         Number of photons radiated per unit time per unit area.
@@ -207,12 +204,10 @@ def photon_flux(self) -> astropy.units.Quantity[astropy.units.Unit("1/(m2 s)")]:
         This convenience method is a special case of :meth:`BEI.full`. This
         method assumes the value of :attr:`order` is 2.
         """
-        flux = (4 * np.pi * float(mpmath.zeta(3)) * self.kT**3) / \
-            (astropy.constants.h**3 * astropy.constants.c**2)
+        flux = (4 * np.pi * float(mpmath.zeta(3)) * self.kT**3) / (astropy.constants.h**3 * astropy.constants.c**2)
 
         return flux.to("1/(m2 s)")
 
-
     def radiant_power_flux(self) -> astropy.units.Quantity[astropy.units.Unit("J/(m2 s)")]:
         """
         Energy radiated per unit time per unit area.
@@ -227,9 +222,8 @@ def radiant_power_flux(self) -> astropy.units.Quantity[astropy.units.Unit("J/(m2
 
         return power_flux.to("J/(m2 s)")
 
-
     @property
-    def kT(self) -> astropy.units.Quantity[astropy.units.dimensionless_unscaled]:  #noqa: N802
+    def kT(self) -> astropy.units.Quantity[astropy.units.dimensionless_unscaled]:  # noqa: N802
         """
         Product of Boltzmann's constant and :attr:`temperature`.
         """
@@ -259,8 +253,7 @@ def prefactor(self) -> astropy.units.Quantity:
         For :attr:`order` equal to `3`, this factor is NOT equal to the
         Stefan-Boltzmann constant because is missing the Riemann-Zeta term.
         """
-        return (2 * np.pi * self.kT**(self.order + 1)) / \
-            (astropy.constants.h**3 * astropy.constants.c**2)
+        return (2 * np.pi * self.kT ** (self.order + 1)) / (astropy.constants.h**3 * astropy.constants.c**2)
 
 
 @attrs.frozen
@@ -297,29 +290,28 @@ class SQSolarcell:
     ValueError
         If ``solar_temperature`` <= 0
     """
+
     bei = attrs.field(init=False)
     bandgap: float | astropy.units.Quantity[astropy.units.eV] = attrs.field(
-            converter=functools.partial(astropy.units.Quantity, unit=astropy.units.eV),
-            validator=[
-                _validate_is_scalar,
-                attrs.validators.ge(0),
-            ]
-        )
+        converter=functools.partial(astropy.units.Quantity, unit=astropy.units.eV),
+        validator=[
+            _validate_is_scalar,
+            attrs.validators.ge(0),
+        ],
+    )
     solar_temperature: float | astropy.units.Quantity[astropy.units.K] = attrs.field(
-            default=5772.,
-            converter=_temperature_converter,
-            validator=[
-                _validate_is_scalar,
-                attrs.validators.gt(0),
-            ]
-        )
-
+        default=5772.0,
+        converter=_temperature_converter,
+        validator=[
+            _validate_is_scalar,
+            attrs.validators.gt(0),
+        ],
+    )
 
     def __attrs_post_init__(self):
-        bei = BEI(order=2, energy_bound=self.bandgap, temperature=self.solar_temperature, chemical_potential=0.)
+        bei = BEI(order=2, energy_bound=self.bandgap, temperature=self.solar_temperature, chemical_potential=0.0)
         object.__setattr__(self, "bei", bei)
 
-
     def power_density(self) -> astropy.units.Quantity[astropy.units.Unit("W/m2")]:
         """
         Solar cell power density
@@ -328,13 +320,12 @@ def power_density(self) -> astropy.units.Quantity[astropy.units.Unit("W/m2")]:
         modification of Shockley & Queisser's :cite:`10.1063/1.1736034` Eq.
         2.4.
         """
-        solar_flux = astropy.units.Quantity(0., "1/(m2 s)") if self.bandgap == 0 else self.bei.upper()
+        solar_flux = astropy.units.Quantity(0.0, "1/(m2 s)") if self.bandgap == 0 else self.bei.upper()
 
         power_density = self.bandgap * solar_flux
 
         return power_density.to("W/m2")
 
-
     def efficiency(self) -> astropy.units.Quantity[astropy.units.dimensionless_unscaled]:
         """
         Solar cell efficiency
@@ -344,7 +335,7 @@ def efficiency(self) -> astropy.units.Quantity[astropy.units.dimensionless_unsca
         """
         power_density = self.power_density()
         solar_power_density = self.bei.radiant_power_flux()
-        efficiency = power_density/solar_power_density
+        efficiency = power_density / solar_power_density
 
         return efficiency.decompose()
 
@@ -392,22 +383,22 @@ class DeVosSolarcell(SQSolarcell):
     ValueError
         If ``planetary_temperature`` <= 0
     """
+
     planetary_temperature: float | astropy.units.Quantity[astropy.units.K] = attrs.field(
-            default=300.,
-            converter=_temperature_converter,
-            validator=[
-                _validate_is_scalar,
-                attrs.validators.gt(0),
-            ]
-        )
+        default=300.0,
+        converter=_temperature_converter,
+        validator=[
+            _validate_is_scalar,
+            attrs.validators.gt(0),
+        ],
+    )
     voltage: float | astropy.units.Quantity[astropy.units.V] = attrs.field(
-            default=0.,
-            converter=functools.partial(astropy.units.Quantity, unit=astropy.units.V),
-            validator=[
-                _validate_is_scalar,
-            ]
-        )
-
+        default=0.0,
+        converter=functools.partial(astropy.units.Quantity, unit=astropy.units.V),
+        validator=[
+            _validate_is_scalar,
+        ],
+    )
 
     def power_density(self) -> astropy.units.Quantity[astropy.units.Unit("W/m2")]:
         """
@@ -421,15 +412,15 @@ def power_density(self) -> astropy.units.Quantity[astropy.units.Unit("W/m2")]:
         electron_energy = astropy.constants.e.si * self.voltage
 
         if self.bandgap == 0:
-            solar_flux = astropy.units.Quantity(0., "1/(m2 s)")
-            solar_cell_flux = astropy.units.Quantity(0., "1/(m2 s)")
+            solar_flux = astropy.units.Quantity(0.0, "1/(m2 s)")
+            solar_cell_flux = astropy.units.Quantity(0.0, "1/(m2 s)")
         else:
             bei = BEI(
-                    order=2,
-                    energy_bound=self.bandgap,
-                    temperature=self.planetary_temperature,
-                    chemical_potential=electron_energy
-                )
+                order=2,
+                energy_bound=self.bandgap,
+                temperature=self.planetary_temperature,
+                chemical_potential=electron_energy,
+            )
             solar_flux = self.bei.upper()
             solar_cell_flux = bei.upper()