Merge pull request #5 from alexfikl/ruff

Enable linting with ruff

Author: Wrzlprmft

.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 }}-${{ matrix.compiler }}-py${{ matrix.python-version }})
     runs-on: ${{ matrix.os }}

docs/conf.py

@@ -1,56 +1,58 @@
-import sys
 import os
+import sys
 from unittest.mock import MagicMock as Mock
+
 from setuptools_scm import get_version
 
+
 # Mocking to make RTD autobuild the documentation. (Doesn’t suffice.)
 # autodoc_mock_imports = [ 'numpy', 'symengine', '.' ]
 
 MOCK_MODULES = [
-	'numpy', 'numpy.testing', 'numpy.random',
-	'symengine', 'symengine.printing', 'symengine.lib.symengine_wrapper',
-	'.'
+	"numpy", "numpy.testing", "numpy.random",
+	"symengine", "symengine.printing", "symengine.lib.symengine_wrapper",
+	"."
 ]
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
 sys.path.insert(0,os.path.abspath("../jitcxde_common"))
 
-needs_sphinx = '1.3'
+needs_sphinx = "1.3"
 
 extensions = [
-		'sphinx.ext.autodoc',
-		'sphinx.ext.autosummary',
-		'sphinx.ext.mathjax',
-		'numpydoc',
+		"sphinx.ext.autodoc",
+		"sphinx.ext.autosummary",
+		"sphinx.ext.mathjax",
+		"numpydoc",
 	]
 
-source_suffix = '.rst'
+source_suffix = ".rst"
 
-master_doc = 'index'
+master_doc = "index"
 
-project = u'JiTC*DE Common'
-copyright = u'2017, Gerrit Ansmann'
+project = "JiTC*DE Common"
+copyright = "2017, 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 = 'JiTC*DEdoc'
+html_theme = "nature"
+pygments_style = "colorful"
+htmlhelp_basename = "JiTC*DEdoc"
 
 numpydoc_show_class_members = False
-autodoc_member_order = 'bysource'
+autodoc_member_order = "bysource"
 
 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)

jitcxde_common/__init__.py

@@ -1,13 +1,10 @@
-from sys import version_info
-if version_info < (3,3):
-	raise NotImplementedError("Python versions below 3.3 are not supported anymore (or never were). Please upgrade to a newer Python version.")
+from ._jitcxde import DEFAULT_COMPILE_ARGS, DEFAULT_LINK_ARGS, MSVC_COMPILE_ARGS, MSVC_LINK_ARGS, jitcxde  # noqa: F401
+from .check import checker  # noqa: F401
+from .symbolic import conditional  # noqa: F401
 
-from ._jitcxde import jitcxde, DEFAULT_COMPILE_ARGS, DEFAULT_LINK_ARGS, MSVC_COMPILE_ARGS, MSVC_LINK_ARGS
-from .symbolic import conditional
-from .check import checker
 
 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)

jitcxde_common/_jitcxde.py

@@ -1,26 +1,26 @@
 #!/usr/bin/python3
-# -*- coding: utf-8 -*-
 
-from tempfile import TemporaryDirectory
-from os import path
-from inspect import stack, isgeneratorfunction, isfunction
-from setuptools import setup, Extension
-from setuptools.command.build_ext import build_ext
+import platform
 import shutil
+from inspect import isgeneratorfunction, stack
+from os import path
+from pickle import PickleError
 from sys import modules
-from warnings import warn
+from tempfile import TemporaryDirectory
 from traceback import format_exc
-from pickle import PickleError
-import platform
+from warnings import warn
 
 import numpy
 from jinja2 import Environment, FileSystemLoader
+from setuptools import Extension, setup
+from setuptools.command.build_ext import build_ext
 from symengine import sympify
 
 from jitcxde_common.check import CheckEnvironment, checker
-from jitcxde_common.modules import get_module_path, modulename_from_path, find_and_load_module, module_from_path, add_suffix
+from jitcxde_common.code import codelines, write_in_chunks
+from jitcxde_common.modules import add_suffix, find_and_load_module, get_module_path, module_from_path, modulename_from_path
 from jitcxde_common.strings import count_up
-from jitcxde_common.code import write_in_chunks, codelines
+
 
 #: A list with the default extra compile arguments. Note that without `-Ofast`, `-ffast-math`, or `-funsafe-math-optimizations` (if supported by your compiler), you may experience a considerable speed loss since SymEngine uses the `pow` function for small integer powers (cf. `SymPy Issue 8997`_).
 DEFAULT_COMPILE_ARGS = [
@@ -67,12 +67,12 @@ def __init__(self,n=None,verbose=True,module_location=None):
 
 		# self.compile_attempt is:
 		#	• None if no compile attempt was made
-		#	• False if a compile attempt was made but not succesful
+		#	• False if a compile attempt was made but not successful
 		#	• True if a successful compile attempt was made
 
 	def _check_dynvar_dict(self,dictionary,name,length):
 		if not set(dictionary.keys()) == {self.dynvar(i) for i in range(length)}:
-			raise ValueError("If %s is a dictionary, its keys must be y(0), y(1), …, y(n) where n is the number of entries." % name)
+			raise ValueError(f"If '{name}' is a dictionary, its keys must be y(0), y(1), …, y(n) where n is the number of entries.")
 
 	def _generator_func_from_dynvar_dict(self,dictionary,name,length):
 		"""
@@ -125,8 +125,10 @@ def _handle_input(self,f_sym,n_basic=False):
 		if n is not None and length != n:
 			raise ValueError("len(f_sym) and n do not match.")
 
-		if n_basic: self.n_basic = length
-		else:       self.n       = length
+		if n_basic:
+			self.n_basic = length
+		else:
+			self.n = length
 
 		if isinstance(f_sym,dict):
 			new_f_sym = self._generator_func_from_dynvar_dict(f_sym,"f_sym",length)
@@ -150,7 +152,7 @@ def _check_dimension_match(self):
 
 	def _tmpfile(self,filename=None):
 		"""
-			returns the path to a file in the tempory directory associated to this instance or the directory itself (if `filename` is None). Creates the directory if necessary.
+			returns the path to a file in the temporary directory associated to this instance or the directory itself (if `filename` is None). Creates the directory if necessary.
 		"""
 		if self._tmpdir is None:
 			self._tmpdir = TemporaryDirectory(
@@ -245,9 +247,9 @@ def _attempt_compilation(self,reset=True):
 		try:
 			self.compile_C()
 		except Exception:
-			warn(format_exc())
+			warn(format_exc(), stacklevel=3)
 			line = "\n"+60*"="+"\n"
-			warn(line + "READ ME FIRST" + line + "Generating compiled integrator failed; resorting to lambdified functions. If you can live with using the Python backend, you can call generate_lambdas to explicitly do this and bypass the compile attempt and error messages. Otherwise, you want to take care of fixing the above errors." + 2*line)
+			warn(f"{line}READ ME FIRST{line}Generating compiled integrator failed; resorting to lambdified functions. If you can live with using the Python backend, you can call generate_lambdas to explicitly do this and bypass the compile attempt and error messages. Otherwise, you want to take care of fixing the above errors.{2*line}", stacklevel=3)
 		else:
 			if reset:
 				self.reset_integrator()
@@ -312,7 +314,7 @@ def build_extensions(self):
 				ext_modules = [extension],
 				script_args = script_args,
 				verbose = verbose,
-				cmdclass = {'build_ext':build_ext_with_compiler_detection}
+				cmdclass = {"build_ext":build_ext_with_compiler_detection}
 			)
 
 		self.jitced = find_and_load_module(self._modulename,self._tmpfile())
@@ -356,7 +358,7 @@ def save_compiled(self, destination="", overwrite=False):
 			raise RuntimeError("Compilation failed. Cannot save module file.")
 
 		if path.isfile(destination) and not overwrite:
-			raise OSError("Target File already exists and \"overwrite\" is set to False")
+			raise OSError('Target File already exists and "overwrite" is set to False')
 		else:
 			shutil.copy(sourcefile, destination)
 
@@ -367,7 +369,7 @@ def __del__(self):
 			try:
 				self._tmpdir.cleanup()
 			except (OSError, AttributeError, TypeError, PermissionError) as error:
-				warn(f"Could not delete temporary directory {self._tmpdir.name} because of the following error:\n{error}")
+				warn(f"Could not delete temporary directory {self._tmpdir.name} because of the following error:\n{error}", stacklevel=2)
 			finally:
 				self._tmpdir = None
 

jitcxde_common/check.py

@@ -5,16 +5,17 @@
 
 from functools import update_wrapper
 
+
 # This class exist just to mark functions
-class checker(object):
+class checker:
 	def __init__(self,function):
 		self.function = function
 		update_wrapper(self,function)
 
 	def __call__(self,*args):
 		self.function(*args)
 
-class CheckEnvironment(object):
+class CheckEnvironment:
 	def _check_assert(self,condition,message):
 		if not condition:
 			self.failed_check = True
@@ -42,7 +43,7 @@ def check(self, fail_fast=True):
 
 		# execute all methods decorated with checker:
 		visited = set()
-		for cls in [self.__class__] + self.__class__.mro():
+		for cls in [self.__class__, *self.__class__.mro()]:
 			for name,member in cls.__dict__.items():
 				if name not in visited and isinstance(member,checker):
 					member(self)

jitcxde_common/code.py

@@ -1,7 +1,10 @@
 from itertools import chain
+
 from symengine.printing import ccode
+
 from jitcxde_common.strings import count_up
 
+
 def codelines(expressions):
 	"""
 	Tries to convert expressions to working code
@@ -14,13 +17,12 @@ def codelines(expressions):
 				raise
 			else:
 				raise NotImplementedError(
-						"Cannot convert the following expression to C Code:\n"
-						+ str(expression)
-					)
+						f"Cannot convert the following expression to C Code:\n{expression}"
+					) from error
 		yield codeline + ";\n"
 
 def render_declarator(name, _type, size=0):
-	return _type + " " + name + ("[%i]"%size if size else "")
+	return _type + " " + name + (f"[{size}]" if size else "")
 
 def write_in_chunks(lines,mainfile,deffile,name,chunk_size,arguments,omp=True):
 	"""

jitcxde_common/helpers.py

@@ -1,5 +1,6 @@
 from symengine import sympify
 
+
 def depends_on_any(helper, other_helpers):
 	for other_helper in other_helpers:
 		if helper[1].has(other_helper[0]):
@@ -60,5 +61,5 @@ def find_dependent_helpers(helpers,dependency):
 	return dependent_helpers
 
 def copy_helpers(helpers):
-	return [helper for helper in helpers]
+	return list(helpers)
 

jitcxde_common/modules.py

@@ -1,9 +1,10 @@
 from sys import version_info
 
-if version_info < (3,3):
+
+if version_info < (3,3):  # noqa: UP036
 	raise NotImplementedError("Python versions below 3.3 are not supported anymore (or never were). Please upgrade to a newer Python version.")
 elif (3,3) <= version_info < (3,5):
-	from jitcxde_common.modules_33 import get_module_path, modulename_from_path, find_and_load_module, module_from_path, add_suffix
+	from jitcxde_common.modules_33 import add_suffix, find_and_load_module, get_module_path, module_from_path, modulename_from_path
 elif (3,5) <= version_info:
-	from jitcxde_common.modules_35 import get_module_path, modulename_from_path, find_and_load_module, module_from_path, add_suffix
+	from jitcxde_common.modules_35 import add_suffix, find_and_load_module, get_module_path, module_from_path, modulename_from_path  # noqa: F401
 

jitcxde_common/modules_33.py

@@ -1,6 +1,7 @@
-from os import path
-from importlib.machinery import ExtensionFileLoader, EXTENSION_SUFFIXES, FileFinder
+from importlib.machinery import EXTENSION_SUFFIXES, ExtensionFileLoader, FileFinder
 from importlib.util import spec_from_file_location
+from os import path
+
 
 loader_details = (ExtensionFileLoader, EXTENSION_SUFFIXES)
 suffices = sorted(EXTENSION_SUFFIXES, key=len)