Enable linting with ruff

.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig - http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = false
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{c,py}]
+charset = utf-8
+
+# tab indentation
+[*.py]
+indent_style = tab
+indent_size = 4

.github/workflows/ci.yml

@@ -14,6 +14,20 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  typos:
+    name: Spelling (typos)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: crate-ci/typos@master
+
+  ruff:
+    name: Linting (ruff)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: chartboost/ruff-action@v1
+
   test:
     name: Unittest (${{ matrix.os }}/py${{ matrix.python-version }})
     runs-on: ${{ matrix.os }}

chspy/__init__.py

@@ -1,13 +1,8 @@
-from ._chspy import (
-		Anchor, CubicHermiteSpline, Extrema,
-		interpolate, interpolate_vec, interpolate_diff, interpolate_diff_vec,
-		extrema_from_anchors,
-		norm_sq_interval, norm_sq_partial, scalar_product_interval, scalar_product_partial,
-		match_anchors, join,
-	)
+from ._chspy import Anchor, CubicHermiteSpline, Extrema, extrema_from_anchors, interpolate, interpolate_diff, interpolate_diff_vec, interpolate_vec, join, match_anchors, norm_sq_interval, norm_sq_partial, scalar_product_interval, scalar_product_partial  # noqa: F401
+
 
 try:
-	from .version import version as __version__
+	from .version import version as __version__  # noqa: F401
 except ImportError:
 	from warnings import warn
-	warn('Failed to find (autogenerated) version.py. Do not worry about this unless you really need to know the version.')
+	warn("Failed to find (autogenerated) version.py. Do not worry about this unless you really need to know the version.", stacklevel=1)

chspy/_chspy.py

@@ -1,10 +1,11 @@
 #!/usr/bin/python3
-# -*- coding: utf-8 -*-
 
-import numpy as np
-from bisect import insort, bisect_left, bisect_right
+from bisect import bisect_left, bisect_right, insort
 from warnings import warn
 
+import numpy as np
+
+
 def rel_dist(x,y):
 	x = np.asarray(x)
 	y = np.asarray(y)
@@ -131,7 +132,7 @@ def norm_sq_interval(anchors, indices):
 
 def norm_sq_partial(anchors, indices, start):
 	"""
-	Returns the sqared norm of the interpolant of `anchors` for the `indices`, but only taking into account the time after `start`.
+	Returns the squared norm of the interpolant of `anchors` for the `indices`, but only taking into account the time after `start`.
 	"""
 	q = (anchors[1].time-anchors[0].time)
 	z = (start-anchors[1].time) / q
@@ -201,7 +202,7 @@ def scalar_product_partial(anchors, indices_1, indices_2, start):
 			vector_2, [1,2]
 		)*q
 
-class Extrema(object):
+class Extrema:
 	"""
 	Class for containing the extrema and their positions in `n` dimensions. These can be accessed via the attributes `minima`, `maxima`, `arg_min`, and `arg_max`.
 	"""
@@ -269,7 +270,7 @@ def extrema_from_anchors(anchors,beginning=None,end=None,target=None):
 	A = 1/(2*a + b - 2*c + d)
 	B = a + 2*b/3 - c + d/3
 	for sign in (-1,1):
-		with np.errstate(invalid='ignore'):
+		with np.errstate(invalid="ignore"):
 			x = (B+sign*np.sqrt(radicant)/3)*A
 			extrema.update(
 					retransform(x),
@@ -479,7 +480,7 @@ def constant(self,state,time=0):
 		"""
 
 		if self:
-			warn("The spline already contains points. This will remove them. Be sure that you really want this.")
+			warn("The spline already contains points. This will remove them. Be sure that you really want this.", stacklevel=2)
 			self.clear()
 
 		self.append(( time-1., state, np.zeros_like(state) ))
@@ -495,7 +496,7 @@ def from_function(self,function,times_of_interest=None,max_anchors=100,tol=5):
 		assert len(times_of_interest)>=2, "I need at least two time points of interest."
 
 		if self:
-			warn("The spline already contains points. This will remove them. Be sure that you really want this. If not, consider using `from_func`.")
+			warn("The spline already contains points. This will remove them. Be sure that you really want this. If not, consider using `from_func`.", stacklevel=2)
 			self.clear()
 
 		# A happy anchor is sufficiently interpolated by its neighbours, temporally close to them, or at the border of the interval.
@@ -623,7 +624,7 @@ def from_data(cls,times,states):
 		t_2 = times [1:-1]
 		t_3 = times [2:  ]
 		diffs[1:-1] = (
-				  y_1 * ((t_2-t_3)/(t_2-t_1)/(t_3-t_1))[:,None]
+				y_1 * ((t_2-t_3)/(t_2-t_1)/(t_3-t_1))[:,None]
 				+ y_2 / (t_2-t_3)[:,None]
 				+ y_2 / (t_2-t_1)[:,None]
 				+ y_3 * ((t_2-t_1)/(t_3-t_1)/(t_3-t_2))[:,None]
@@ -663,7 +664,7 @@ def get_recent_state(self,t):
 		"""
 		anchors = self[-2], self[-1]
 		output = interpolate_vec(t,anchors)
-		assert type(output) == np.ndarray
+		assert type(output) is np.ndarray
 		return output
 
 	def get_current_state(self):
@@ -744,8 +745,6 @@ def solve(self,i,value,beginning=None,end=None,solve_derivative=False):
 		if not self[0].time <= beginning < end <= self[-1].time:
 			raise ValueError("Beginning and end must in the time interval spanned by the anchors.")
 
-		extrema = Extrema(self.n)
-
 		sols = []
 
 		for j in range(self.last_index_before(beginning),len(self)-1):
@@ -779,8 +778,8 @@ def norm(self, delay, indices):
 		norm_sq = norm_sq_partial(anchors, indices, threshold)
 
 		# full norms of all others
-		for i in range(i+1, len(self)-1):
-			anchors = (self[i],self[i+1])
+		for j in range(i+1, len(self)-1):
+			anchors = (self[j],self[j+1])
 			norm_sq += norm_sq_interval(anchors, indices)
 
 		return np.sqrt(norm_sq)
@@ -797,8 +796,8 @@ def scalar_product(self, delay, indices_1, indices_2):
 		sp = scalar_product_partial(anchors, indices_1, indices_2, threshold)
 
 		# full scalar product of all others
-		for i in range(i+1, len(self)-1):
-			anchors = (self[i],self[i+1])
+		for j in range(i+1, len(self)-1):
+			anchors = (self[j],self[j+1])
 			sp += scalar_product_interval(anchors, indices_1, indices_2)
 
 		return sp
@@ -813,7 +812,7 @@ def scale(self, indices, factor):
 
 	def subtract(self, indices_1, indices_2, factor):
 		"""
-		Substract the spline for `indices_2` multiplied by `factor` from the spline for `indices_1`.
+		Subtract the spline for `indices_2` multiplied by `factor` from the spline for `indices_1`.
 		"""
 		for anchor in self:
 			anchor.state[indices_1] -= factor*anchor.state[indices_2]
@@ -853,7 +852,7 @@ def plus(self,other):
 		match_anchors(self,other)
 		assert self.times == other.times
 
-		for i,anchor in enumerate(other):
+		for i,_anchor in enumerate(other):
 			self[i].state += other[i].state
 			self[i].diff  += other[i].diff
 
@@ -892,7 +891,7 @@ def plot(self,axes,components="all",resolution=20,*args,**kwargs):
 		kwargs.setdefault("markevery",resolution)
 		values = self.get_state(plot_times)
 		return [
-				axes.plot( plot_times, values[:,c], label=f"Component {c}", *args, **kwargs )
+				axes.plot( plot_times, values[:,c], *args, label=f"Component {c}", **kwargs )
 				for c in (components)
 			]
 

docs/conf.py

@@ -1,56 +1,57 @@
-import sys
 import os
+import sys
+
 from setuptools_scm import get_version
-from unittest.mock import MagicMock as Mock
+
 
 # Mocking to make RTD autobuild the documentation.
-autodoc_mock_imports = ['numpy']
+autodoc_mock_imports = ["numpy"]
 #sys.modules.update([("numpy", Mock())])
 sys.path.insert(0,os.path.abspath("../chspy"))
 sys.path.insert(0,os.path.abspath("../examples"))
 
-needs_sphinx = '1.6'
+needs_sphinx = "1.6"
 
 extensions = [
-	'sphinx.ext.autodoc',
-	'sphinx.ext.autosummary',
-	'sphinx.ext.mathjax',
-	'matplotlib.sphinxext.plot_directive',
-	'numpydoc',
+	"sphinx.ext.autodoc",
+	"sphinx.ext.autosummary",
+	"sphinx.ext.mathjax",
+	"matplotlib.sphinxext.plot_directive",
+	"numpydoc",
 ]
 
-source_suffix = '.rst'
+source_suffix = ".rst"
 
-master_doc = 'index'
+master_doc = "index"
 
-project = 'CHSPy'
-copyright = '2019, Gerrit Ansmann'
+project = "CHSPy"
+copyright = "2019, Gerrit Ansmann"
 
-release = version = get_version(root='..', relative_to=__file__)
+release = version = get_version(root="..", relative_to=__file__)
 
 default_role = "any"
 
 add_function_parentheses = True
 
 add_module_names = False
 
-html_theme = 'nature'
-pygments_style = 'colorful'
-htmlhelp_basename = 'CHSPydoc'
+html_theme = "nature"
+pygments_style = "colorful"
+htmlhelp_basename = "CHSPydoc"
 
 plot_html_show_formats = False
 plot_html_show_source_link = False
 
 numpydoc_show_class_members = False
-autodoc_member_order = 'bysource'
+autodoc_member_order = "bysource"
 
-toc_object_entries_show_parents = 'hide'
+toc_object_entries_show_parents = "hide"
 
 def on_missing_reference(app, env, node, contnode):
-	if node['reftype'] == 'any':
+	if node["reftype"] == "any":
 		return contnode
 	else:
 		return None
 
 def setup(app):
-	app.connect('missing-reference', on_missing_reference)
+	app.connect("missing-reference", on_missing_reference)

examples/simple_example.py

@@ -1,6 +1,8 @@
-from chspy import CubicHermiteSpline
 from matplotlib.pyplot import subplots
 
+from chspy import CubicHermiteSpline
+
+
 spline = CubicHermiteSpline(n=3)
 
 #            time   state    slope

pyproject.toml

@@ -43,3 +43,45 @@ include = [
 
 [tool.setuptools_scm]
 write_to = "chspy/version.py"
+
+[tool.ruff]
+target-version = "py37"
+line-length = 320
+
+[tool.ruff.lint]
+select = [
+    "A",   # flake8-builtins
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "E",   # flake8
+    "F",   # flake8
+    "I",   # flake8-isort
+    "NPY", # numpy
+    "Q",   # flake8-quotes
+    "RUF", # ruff
+    "UP",  # pyupgrade
+    "W",   # flake8
+]
+ignore = [
+    "A001",     # shadowing-builtin-variable
+    "A005",     # shadowing-builtin-module
+    "C409",     # incorrectly-parenthesized-tuple-in-subscript
+    "E203",     # whitespace-before-punctuation
+    "E402",     # module-import-not-at-top-of-file
+    "E501",     # line-too-long
+    "E731",     # assign-to-lambda
+    "RUF001",   # ambiguous-unicode-character-string
+    "RUF002",   # ambiguous-unicode-character-docstring
+    "W191",     # indentation-contains-tabs
+    "W293",     # blank-line-with-whitespace
+]
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"
+inline-quotes = "double"
+multiline-quotes = "double"
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+known-local-folder = [ "CHSPy" ]
+lines-after-imports = 2