mapFolding 0.4.2__py3-none-any.whl → 0.5.0__py3-none-any.whl

mapFolding/__init__.py

@@ -11,6 +11,7 @@ from mapFolding.theSSOT import (
 
 # Datatype management
 from mapFolding.theSSOT import (
+	getDatatypeModule,
 	hackSSOTdatatype,
 	hackSSOTdtype,
 	setDatatypeElephino,
@@ -21,7 +22,7 @@ from mapFolding.theSSOT import (
 
 # Synthesize modules
 from mapFolding.theSSOT import (
-	formatModuleNameDEFAULT,
+	formatFilenameModuleDEFAULT,
 	getAlgorithmDispatcher,
 	getAlgorithmSource,
 	getPathJobRootDEFAULT,
@@ -60,7 +61,7 @@ from mapFolding.beDRY import (
 from mapFolding.basecamp import countFolds
 from mapFolding.oeis import clearOEIScache, getOEISids, oeisIDfor_n
 
-__all__ = [
+__all__: list[str] = [
 	'clearOEIScache',
 	'countFolds',
 	'getOEISids',

mapFolding/basecamp.py

@@ -1,12 +1,13 @@
+from collections.abc import Sequence
 from mapFolding import computationState, getDispatcherCallable, getPathFilenameFoldsTotal, outfitCountFolds, saveFoldsTotal
-from typing import Optional, Sequence, Union
-import os
-
-def countFolds(listDimensions: Sequence[int]
-				, pathLikeWriteFoldsTotal: Optional[Union[str, os.PathLike[str]]] = None
-				, computationDivisions: Optional[Union[int, str]] = None
-				, CPUlimit: Optional[Union[int, float, bool]] = None
-				, **keywordArguments: Optional[Union[str, bool]]
+from os import PathLike
+from pathlib import Path
+
+def countFolds(listDimensions: Sequence[int],
+				pathLikeWriteFoldsTotal: str | PathLike[str] | None = None,
+				computationDivisions: int | str | None = None,
+				CPUlimit: int | float | bool | None = None,
+				**keywordArguments: str | bool
 				) -> int:
 	"""Count the total number of possible foldings for a given map dimensions.
 
@@ -17,7 +18,7 @@ def countFolds(listDimensions: Sequence[int]
 		computationDivisions (None):
 			Whether and how to divide the computational work. See notes for details.
 		CPUlimit (None): This is only relevant if there are `computationDivisions`: whether and how to limit the CPU usage. See notes for details.
-		**keywordArguments: Datatype management.
+		**keywordArguments: Datatype management. See `outfitCountFolds` for details.
 	Returns:
 		foldsTotal: Total number of distinct ways to fold a map of the given dimensions.
 
@@ -40,16 +41,13 @@ def countFolds(listDimensions: Sequence[int]
 	"""
 	stateUniversal: computationState = outfitCountFolds(listDimensions, computationDivisions=computationDivisions, CPUlimit=CPUlimit, **keywordArguments)
 
-	pathFilenameFoldsTotal = None
-	if pathLikeWriteFoldsTotal is not None:
-		pathFilenameFoldsTotal = getPathFilenameFoldsTotal(stateUniversal['mapShape'], pathLikeWriteFoldsTotal)
-
 	dispatcher = getDispatcherCallable()
 	dispatcher(**stateUniversal)
 
 	foldsTotal = int(stateUniversal['foldGroups'][0:-1].sum() * stateUniversal['foldGroups'][-1])
 
-	if pathFilenameFoldsTotal is not None:
+	if pathLikeWriteFoldsTotal is not None:
+		pathFilenameFoldsTotal: Path = getPathFilenameFoldsTotal(stateUniversal['mapShape'], pathLikeWriteFoldsTotal)
 		saveFoldsTotal(pathFilenameFoldsTotal, foldsTotal)
 
 	return foldsTotal

mapFolding/beDRY.py

@@ -1,6 +1,7 @@
 """A relatively stable API for oft-needed functionality."""
 from mapFolding import (
 	computationState,
+	getDatatypeModule,
 	getPathJobRootDEFAULT,
 	hackSSOTdatatype,
 	hackSSOTdtype,
@@ -9,35 +10,39 @@ from mapFolding import (
 	setDatatypeElephino,
 	setDatatypeFoldsTotal,
 	setDatatypeLeavesTotal,
+	setDatatypeModule,
 )
+from collections.abc import Sequence
+from numba import get_num_threads, set_num_threads
 from numpy import dtype, integer, ndarray
 from numpy.typing import DTypeLike, NDArray
-from typing import Any, List, Optional, Sequence, Tuple, Union
+from pathlib import Path
+from sys import maxsize as sysMaxsize
+from typing import Any
 from Z0Z_tools import defineConcurrencyLimit, intInnit, oopsieKwargsie
-import numba
 import numpy
 import os
-import pathlib
-import sys
 
-def getFilenameFoldsTotal(mapShape: Union[Sequence[int], ndarray[Tuple[int], dtype[integer[Any]]]]) -> str:
-	"""Make a standardized filename for the computed value `foldsTotal`.
+def getFilenameFoldsTotal(mapShape: Sequence[int] | ndarray[tuple[int], dtype[integer[Any]]]) -> str:
+	"""Imagine your computer has been counting folds for 70 hours, and when it tries to save your newly discovered value,
+	the filename is invalid. I bet you think this function is more important after that thought experiment.
+
+	Make a standardized filename for the computed value `foldsTotal`.
 
 	The filename takes into account
 		- the dimensions of the map, aka `mapShape`, aka `listDimensions`
 		- no spaces in the filename
-		- safe filesystem characters across platforms
+		- safe filesystem characters
 		- unique extension
-		- avoiding potential problems when Python is manipulating the filename, including
-			- treating the file stem as a valid Python identifier, such as
-				- not starting with a number
-				- not using reserved words
-				- no dashes or other special characters
-			- uh, I can't remember, but I found some frustrating edge limitations
-		- if 'p' is still the first character, I picked that because it was the original identifier for the map shape in Lunnan's code
+		- Python-safe strings:
+			- no starting with a number
+			- no reserved words
+			- no dashes or other special characters
+			- uh, I can't remember, but I found some other frustrating limitations
+		- if 'p' is still the first character of the filename, I picked that because it was the original identifier for the map shape in Lunnan's code
 
 	Parameters:
-		mapShape: A sequence of integers representing the dimensions of the map (e.g., [3, 2] for a 3x2 map)
+		mapShape: A sequence of integers representing the dimensions of the map.
 
 	Returns:
 		filenameFoldsTotal: A filename string in format 'pNxM.foldsTotal' where N,M are sorted dimensions
@@ -62,13 +67,13 @@ def getLeavesTotal(listDimensions: Sequence[int]) -> int:
 	else:
 		productDimensions = 1
 		for dimension in listPositive:
-			if dimension > sys.maxsize // productDimensions:
+			if dimension > sysMaxsize // productDimensions:
 				raise OverflowError(f"I received {dimension=} in {listDimensions=}, but the product of the dimensions exceeds the maximum size of an integer on this system.")
 			productDimensions *= dimension
 
 		return productDimensions
 
-def getPathFilenameFoldsTotal(mapShape: Union[Sequence[int], ndarray[Tuple[int], dtype[integer[Any]]]], pathLikeWriteFoldsTotal: Optional[Union[str, os.PathLike[str]]] = None) -> pathlib.Path:
+def getPathFilenameFoldsTotal(mapShape: Sequence[int] | ndarray[tuple[int], dtype[integer[Any]]], pathLikeWriteFoldsTotal: str | os.PathLike[str] | None = None) -> Path:
 	"""Get a standardized path and filename for the computed value `foldsTotal`.
 
 	If you provide a directory, the function will append a standardized filename. If you provide a filename
@@ -82,7 +87,7 @@ def getPathFilenameFoldsTotal(mapShape: Union[Sequence[int], ndarray[Tuple[int],
 	Returns:
 		pathFilenameFoldsTotal: Absolute path and filename.
 	"""
-	pathLikeSherpa = pathlib.Path(pathLikeWriteFoldsTotal) if pathLikeWriteFoldsTotal is not None else None
+	pathLikeSherpa = Path(pathLikeWriteFoldsTotal) if pathLikeWriteFoldsTotal is not None else None
 	if not pathLikeSherpa:
 		pathLikeSherpa = getPathJobRootDEFAULT()
 	if pathLikeSherpa.is_dir():
@@ -95,35 +100,38 @@ def getPathFilenameFoldsTotal(mapShape: Union[Sequence[int], ndarray[Tuple[int],
 	pathFilenameFoldsTotal.parent.mkdir(parents=True, exist_ok=True)
 	return pathFilenameFoldsTotal
 
-def getTaskDivisions(computationDivisions: Optional[Union[int, str]], concurrencyLimit: int, CPUlimit: Optional[Union[bool, float, int]], listDimensions: Sequence[int]) -> int:
+def getTaskDivisions(computationDivisions: int | str | None, concurrencyLimit: int, CPUlimit: bool | float | int | None, listDimensions: Sequence[int]) -> int:
 	"""
-	Determines whether or how to divide the computation into tasks.
+	Determines whether to divide the computation into tasks and how many divisions.
 
 	Parameters
 	----------
-	computationDivisions (None):
+	computationDivisions (None)
 		Specifies how to divide computations:
-		- None: no division of the computation into tasks; sets task divisions to 0
-		- int: direct set the number of task divisions; cannot exceed the map's total leaves
-		- "maximum": divides into `leavesTotal`-many `taskDivisions`
-		- "cpu": limits the divisions to the number of available CPUs, i.e. `concurrencyLimit`
-		concurrencyLimit:
-			Maximum number of concurrent tasks allowed
-		CPUlimit: for error reporting
-		listDimensions: for error reporting
+		- `None`: no division of the computation into tasks; sets task divisions to 0.
+		- int: direct set the number of task divisions; cannot exceed the map's total leaves.
+		- `'maximum'`: divides into `leavesTotal`-many `taskDivisions`.
+		- `'cpu'`: limits the divisions to the number of available CPUs, i.e. `concurrencyLimit`.
+	concurrencyLimit
+		Maximum number of concurrent tasks allowed.
+	CPUlimit
+		for error reporting.
+	listDimensions
+		for error reporting.
 
 	Returns
 	-------
-		taskDivisions:
+	taskDivisions
+		How many tasks must finish before the job can compute the total number of folds; `0` means no tasks, only job.
 
 	Raises
 	------
-		ValueError
-			If computationDivisions is an unsupported type or if resulting task divisions exceed total leaves
+	ValueError
+		If computationDivisions is an unsupported type or if resulting task divisions exceed total leaves.
 
 	Notes
 	-----
-	Task divisions should not exceed total leaves to prevent duplicate counting of folds.
+	Task divisions should not exceed total leaves or the folds will be over-counted.
 	"""
 	taskDivisions = 0
 	leavesTotal = getLeavesTotal(listDimensions)
@@ -133,9 +141,9 @@ def getTaskDivisions(computationDivisions: Optional[Union[int, str]], concurrenc
 		taskDivisions = computationDivisions
 	elif isinstance(computationDivisions, str):
 		computationDivisions = computationDivisions.lower()
-		if computationDivisions == "maximum":
+		if computationDivisions == 'maximum':
 			taskDivisions = leavesTotal
-		elif computationDivisions == "cpu":
+		elif computationDivisions == 'cpu':
 			taskDivisions = min(concurrencyLimit, leavesTotal)
 	else:
 		raise ValueError(f"I received {computationDivisions} for the parameter, `computationDivisions`, but the so-called programmer didn't implement code for that.")
@@ -145,7 +153,7 @@ def getTaskDivisions(computationDivisions: Optional[Union[int, str]], concurrenc
 
 	return taskDivisions
 
-def makeConnectionGraph(listDimensions: Sequence[int], **keywordArguments: Optional[str]) -> ndarray[Tuple[int, int, int], dtype[integer[Any]]]:
+def makeConnectionGraph(listDimensions: Sequence[int], **keywordArguments: str | None) -> ndarray[tuple[int, int, int], dtype[integer[Any]]]:
 	"""
 	Constructs a multi-dimensional connection graph representing the connections between the leaves of a map with the given dimensions.
 	Also called a Cartesian product decomposition or dimensional product mapping.
@@ -172,7 +180,7 @@ def makeConnectionGraph(listDimensions: Sequence[int], **keywordArguments: Optio
 		for leaf1ndex in range(1, leavesTotal + 1):
 			coordinateSystem[indexDimension, leaf1ndex] = ( ((leaf1ndex - 1) // cumulativeProduct[indexDimension]) % arrayDimensions[indexDimension] + 1 )
 
-	connectionGraph = numpy.zeros((dimensionsTotal, leavesTotal + 1, leavesTotal + 1), dtype=dtype)
+	connectionGraph: ndarray[tuple[int, int, int], numpy.dtype[integer[Any]]] = numpy.zeros((dimensionsTotal, leavesTotal + 1, leavesTotal + 1), dtype=dtype)
 	for indexDimension in range(dimensionsTotal):
 		for activeLeaf1ndex in range(1, leavesTotal + 1):
 			for connectee1ndex in range(1, activeLeaf1ndex + 1):
@@ -190,23 +198,29 @@ def makeConnectionGraph(listDimensions: Sequence[int], **keywordArguments: Optio
 
 	return connectionGraph
 
-def makeDataContainer(shape: Union[int, Tuple[int, ...]], datatype: Optional[DTypeLike] = None) -> NDArray[integer[Any]]:
+def makeDataContainer(shape: int | tuple[int, ...], datatype: DTypeLike | None = None) -> NDArray[integer[Any]]:
 	"""Create a zeroed-out `ndarray` with the given shape and datatype.
 
 	Parameters:
 		shape: The shape of the array. Can be an integer for 1D arrays
 			or a tuple of integers for multi-dimensional arrays.
-		datatype: The desired data type for the array.
-			If None, defaults to dtypeLargeDEFAULT. Defaults to None.
+		datatype ('dtypeFoldsTotal'): The desired data type for the array.
+			If `None`, defaults to 'dtypeFoldsTotal'. Defaults to None.
 
 	Returns:
 		dataContainer: A new array of given shape and type, filled with zeros.
+
+	Notes:
+		If a version of the algorithm were to use something other than numpy, such as JAX or CUDA, because other
+		functions use this function, it would be much easier to change the datatype "ecosystem".
 	"""
-	if datatype is None:
-		datatype = hackSSOTdtype('dtypeFoldsTotal')
-	return numpy.zeros(shape, dtype=datatype)
+	numpyDtype = datatype or hackSSOTdtype('dtypeFoldsTotal')
+	if 'numpy' == getDatatypeModule():
+		return numpy.zeros(shape, dtype=numpyDtype)
+	else:
+		raise NotImplementedError("Somebody done broke it.")
 
-def outfitCountFolds(listDimensions: Sequence[int], computationDivisions: Optional[Union[int, str]] = None, CPUlimit: Optional[Union[bool, float, int]] = None, **keywordArguments: Optional[Union[str, bool]]) -> computationState:
+def outfitCountFolds(listDimensions: Sequence[int], computationDivisions: int | str | None = None, CPUlimit: bool | float | int | None = None, **keywordArguments: str | bool | None) -> computationState:
 	"""
 	Initializes and configures the computation state for map folding computations.
 
@@ -214,11 +228,12 @@ def outfitCountFolds(listDimensions: Sequence[int], computationDivisions: Option
 		listDimensions: The dimensions of the map to be folded
 		computationDivisions (None): see `getTaskDivisions`
 		CPUlimit (None): see `setCPUlimit`
-		**keywordArguments: Datatype management.
+		**keywordArguments: Datatype management, it's complicated: see the code below.
 
 	Returns:
 		stateInitialized: The initialized computation state
 	"""
+	# keywordArguments START
 	kwourGrapes = keywordArguments.get('sourGrapes', None)
 	if kwourGrapes:
 		sourGrapes = True
@@ -240,6 +255,13 @@ def outfitCountFolds(listDimensions: Sequence[int], computationDivisions: Option
 		ImaSetTheDatatype = str(ImaSetTheDatatype)
 		setDatatypeLeavesTotal(ImaSetTheDatatype, sourGrapes)
 
+	# NOTE well: this might be only hypothetical because as of this writing, `makeDataContainer` only makes numpy.zeros. But it's here in case things change.
+	ImaSetTheDatatype = keywordArguments.get('datatypeModule', None)
+	if ImaSetTheDatatype:
+		ImaSetTheDatatype = str(ImaSetTheDatatype)
+		setDatatypeModule(ImaSetTheDatatype, sourGrapes)
+	# keywordArguments END
+
 	my = makeDataContainer(len(indexMy), hackSSOTdtype('my'))
 
 	mapShape = tuple(sorted(validateListDimensions(listDimensions)))
@@ -263,18 +285,18 @@ def outfitCountFolds(listDimensions: Sequence[int], computationDivisions: Option
 
 	return stateInitialized
 
-def parseDimensions(dimensions: Sequence[int], parameterName: str = 'listDimensions') -> List[int]:
+def parseDimensions(dimensions: Sequence[int], parameterName: str = 'listDimensions') -> list[int]:
 	"""
-	Parse and validate dimensions are non-negative integers.
+	Parse and validate the dimensions are non-negative integers.
 
 	Parameters:
-		dimensions: Sequence of integers representing dimensions
-		parameterName ('listDimensions'): Name of the parameter for error messages. Defaults to 'listDimensions'
+		dimensions: Sequence of integers representing dimensions.
+		parameterName ('listDimensions'): Name of the parameter for error messages. Defaults to 'listDimensions'.
 	Returns:
-		listNonNegative: List of validated non-negative integers
+		listNonNegative: List of validated non-negative integers.
 	Raises:
-		ValueError: If any dimension is negative or if the list is empty
-		TypeError: If any element cannot be converted to integer (raised by intInnit)
+		ValueError: If any dimension is negative or if the list is empty.
+		TypeError: If any element cannot be converted to integer (raised by `intInnit`).
 	"""
 	listValidated = intInnit(dimensions, parameterName)
 	listNonNegative = []
@@ -285,7 +307,7 @@ def parseDimensions(dimensions: Sequence[int], parameterName: str = 'listDimensi
 
 	return listNonNegative
 
-def saveFoldsTotal(pathFilename: Union[str, os.PathLike[str]], foldsTotal: int) -> None:
+def saveFoldsTotal(pathFilename: str | os.PathLike[str], foldsTotal: int) -> None:
 	"""
 	Save foldsTotal with multiple fallback mechanisms.
 
@@ -294,7 +316,7 @@ def saveFoldsTotal(pathFilename: Union[str, os.PathLike[str]], foldsTotal: int)
 		foldsTotal: Critical computed value to save
 	"""
 	try:
-		pathFilenameFoldsTotal = pathlib.Path(pathFilename)
+		pathFilenameFoldsTotal = Path(pathFilename)
 		pathFilenameFoldsTotal.parent.mkdir(parents=True, exist_ok=True)
 		pathFilenameFoldsTotal.write_text(str(foldsTotal))
 	except Exception as ERRORmessage:
@@ -312,7 +334,7 @@ def saveFoldsTotal(pathFilename: Union[str, os.PathLike[str]], foldsTotal: int)
 		except Exception:
 			print(foldsTotal)
 
-def setCPUlimit(CPUlimit: Optional[Any]) -> int:
+def setCPUlimit(CPUlimit: Any | None) -> int:
 	"""Sets CPU limit for Numba concurrent operations. Note that it can only affect Numba-jitted functions that have not yet been imported.
 
 	Parameters:
@@ -334,11 +356,12 @@ def setCPUlimit(CPUlimit: Optional[Any]) -> int:
 		CPUlimit = oopsieKwargsie(CPUlimit)
 
 	concurrencyLimit = int(defineConcurrencyLimit(CPUlimit))
-	numba.set_num_threads(concurrencyLimit)
+	set_num_threads(concurrencyLimit)
+	concurrencyLimit = get_num_threads()
 
 	return concurrencyLimit
 
-def validateListDimensions(listDimensions: Sequence[int]) -> List[int]:
+def validateListDimensions(listDimensions: Sequence[int]) -> list[int]:
 	"""
 	Validates and sorts a sequence of at least two positive dimensions.
 
@@ -349,7 +372,7 @@ def validateListDimensions(listDimensions: Sequence[int]) -> List[int]:
 		dimensionsValidSorted: A list, with at least two elements, of only positive integers.
 
 	Raises:
-		ValueError: If the input listDimensions is None.
+		ValueError: If the input listDimensions is empty.
 		NotImplementedError: If the resulting list of positive dimensions has fewer than two elements.
 	"""
 	if not listDimensions:

mapFolding/oeis.py

@@ -1,8 +1,8 @@
-"""Everything implementing the The Online Encyclopedia of Integer Sequences (OEIS);
-_only_ things that implement _only_ the OEIS."""
+"""Everything implementing the The Online Encyclopedia of Integer Sequences (OEIS); _only_ things that implement _only_ the OEIS."""
+from collections.abc import Callable
 from datetime import datetime, timedelta
 from mapFolding import countFolds, getPathPackage
-from typing import Any, Callable, Dict, Final, List, Tuple, TYPE_CHECKING, Union
+from typing import Any, Final, TYPE_CHECKING
 import argparse
 import pathlib
 import random
@@ -17,6 +17,8 @@ if TYPE_CHECKING:
 else:
 	TypedDict = dict
 
+cacheDays = 7
+
 """
 Section: make `settingsOEIS`"""
 
@@ -24,15 +26,15 @@ _pathCache = getPathPackage() / ".cache"
 
 class SettingsOEIS(TypedDict):
 	description: str
+	getMapShape: Callable[[int], list[int]]
 	offset: int
-	getMapShape: Callable[[int], List[int]]
-	valuesBenchmark: List[int]
-	valuesKnown: Dict[int, int]
-	valuesTestParallelization: List[int]
-	valuesTestValidation: List[int]
+	valuesBenchmark: list[int]
+	valuesKnown: dict[int, int]
+	valuesTestParallelization: list[int]
+	valuesTestValidation: list[int]
 	valueUnknown: int
 
-settingsOEIShardcodedValues: Dict[str, Dict[str, Any]] = {
+settingsOEIShardcodedValues: dict[str, dict[str, Any]] = {
 	'A001415': {
 		'getMapShape': lambda n: sorted([2, n]),
 		'valuesBenchmark': [14],
@@ -65,10 +67,10 @@ settingsOEIShardcodedValues: Dict[str, Dict[str, Any]] = {
 	},
 }
 
-oeisIDsImplemented: Final[List[str]]  = sorted([oeisID.upper().strip() for oeisID in settingsOEIShardcodedValues.keys()])
+oeisIDsImplemented: Final[list[str]]  = sorted([oeisID.upper().strip() for oeisID in settingsOEIShardcodedValues.keys()])
 """Directly implemented OEIS IDs; standardized, e.g., 'A001415'."""
 
-def _validateOEISid(oeisIDcandidate: str) -> str:
+def validateOEISid(oeisIDcandidate: str) -> str:
 	"""
 	Validates an OEIS sequence ID against implemented sequences.
 
@@ -98,13 +100,14 @@ def _validateOEISid(oeisIDcandidate: str) -> str:
 				f"Available sequences:\n{_formatOEISsequenceInfo()}"
 			)
 
-def _getFilenameOEISbFile(oeisID: str) -> str:
-	oeisID = _validateOEISid(oeisID)
+def getFilenameOEISbFile(oeisID: str) -> str:
+	oeisID = validateOEISid(oeisID)
 	return f"b{oeisID[1:]}.txt"
 
-def _parseBFileOEIS(OEISbFile: str, oeisID: str) -> Dict[int, int]:
+def _parseBFileOEIS(OEISbFile: str, oeisID: str) -> dict[int, int]:
 	"""
 	Parses the content of an OEIS b-file for a given sequence ID.
+
 	This function processes a multiline string representing an OEIS b-file and
 	creates a dictionary mapping integer indices to their corresponding sequence
 	values. The first line of the b-file is expected to contain a comment that
@@ -133,8 +136,7 @@ def _parseBFileOEIS(OEISbFile: str, oeisID: str) -> Dict[int, int]:
 		OEISsequence[n] = aOFn
 	return OEISsequence
 
-def _getOEISofficial(pathFilenameCache: pathlib.Path, url: str) -> None | str:
-	cacheDays = 7
+def getOEISofficial(pathFilenameCache: pathlib.Path, url: str) -> None | str:
 	tryCache = False
 	if pathFilenameCache.exists():
 		fileAge = datetime.now() - datetime.fromtimestamp(pathFilenameCache.stat().st_mtime)
@@ -144,7 +146,7 @@ def _getOEISofficial(pathFilenameCache: pathlib.Path, url: str) -> None | str:
 	if tryCache:
 		try:
 			oeisInformation = pathFilenameCache.read_text()
-		except IOError:
+		except OSError:
 			tryCache = False
 
 	if not tryCache:
@@ -158,7 +160,7 @@ def _getOEISofficial(pathFilenameCache: pathlib.Path, url: str) -> None | str:
 
 	return oeisInformation
 
-def _getOEISidValues(oeisID: str) -> Dict[int, int]:
+def getOEISidValues(oeisID: str) -> dict[int, int]:
 	"""
 	Retrieves the specified OEIS sequence as a dictionary mapping integer indices
 	to their corresponding values.
@@ -177,21 +179,21 @@ def _getOEISidValues(oeisID: str) -> Dict[int, int]:
 		IOError: If there is an error reading from or writing to the local cache.
 	"""
 
-	pathFilenameCache = _pathCache / _getFilenameOEISbFile(oeisID)
-	url = f"https://oeis.org/{oeisID}/{_getFilenameOEISbFile(oeisID)}"
+	pathFilenameCache = _pathCache / getFilenameOEISbFile(oeisID)
+	url = f"https://oeis.org/{oeisID}/{getFilenameOEISbFile(oeisID)}"
 
-	oeisInformation = _getOEISofficial(pathFilenameCache, url)
+	oeisInformation = getOEISofficial(pathFilenameCache, url)
 
 	if oeisInformation:
 		return _parseBFileOEIS(oeisInformation, oeisID)
 	return {-1: -1}
 
-def _getOEISidInformation(oeisID: str) -> Tuple[str, int]:
-	oeisID = _validateOEISid(oeisID)
+def getOEISidInformation(oeisID: str) -> tuple[str, int]:
+	oeisID = validateOEISid(oeisID)
 	pathFilenameCache = _pathCache / f"{oeisID}.txt"
 	url = f"https://oeis.org/search?q=id:{oeisID}&fmt=text"
 
-	oeisInformation = _getOEISofficial(pathFilenameCache, url)
+	oeisInformation = getOEISofficial(pathFilenameCache, url)
 
 	if not oeisInformation:
 		return "Not found", -1
@@ -218,11 +220,11 @@ def _getOEISidInformation(oeisID: str) -> Tuple[str, int]:
 	description = ' '.join(description_parts)
 	return description, offset
 
-def makeSettingsOEIS() -> Dict[str, SettingsOEIS]:
+def makeSettingsOEIS() -> dict[str, SettingsOEIS]:
 	settingsTarget = {}
 	for oeisID in oeisIDsImplemented:
-		valuesKnownSherpa = _getOEISidValues(oeisID)
-		descriptionSherpa, offsetSherpa = _getOEISidInformation(oeisID)
+		valuesKnownSherpa = getOEISidValues(oeisID)
+		descriptionSherpa, offsetSherpa = getOEISidInformation(oeisID)
 		settingsTarget[oeisID] = SettingsOEIS(
 			description=descriptionSherpa,
 			offset=offsetSherpa,
@@ -235,7 +237,7 @@ def makeSettingsOEIS() -> Dict[str, SettingsOEIS]:
 		)
 	return settingsTarget
 
-settingsOEIS: Dict[str, SettingsOEIS] = makeSettingsOEIS()
+settingsOEIS: dict[str, SettingsOEIS] = makeSettingsOEIS()
 """All values and settings for `oeisIDsImplemented`."""
 
 """
@@ -282,12 +284,12 @@ def oeisIDfor_n(oeisID: str, n: int) -> int:
 		ValueError: If n is negative.
 		KeyError: If the OEIS sequence ID is not directly implemented.
 	"""
-	oeisID = _validateOEISid(oeisID)
+	oeisID = validateOEISid(oeisID)
 
 	if not isinstance(n, int) or n < 0:
 		raise ValueError("`n` must be non-negative integer.")
 
-	listDimensions = settingsOEIS[oeisID]['getMapShape'](n)
+	listDimensions: list[int] = settingsOEIS[oeisID]['getMapShape'](n)
 
 	if n <= 1 or len(listDimensions) < 2:
 		offset = settingsOEIS[oeisID]['offset']
@@ -308,9 +310,9 @@ def OEIS_for_n() -> None:
 	parserCLI.add_argument('oeisID', help="OEIS sequence identifier")
 	parserCLI.add_argument('n', type=int, help="Calculate a(n) for this n")
 
-	argumentsCLI = parserCLI.parse_args()
+	argumentsCLI: argparse.Namespace = parserCLI.parse_args()
 
-	timeStart = time.perf_counter()
+	timeStart: float = time.perf_counter()
 
 	try:
 		print(oeisIDfor_n(argumentsCLI.oeisID, argumentsCLI.n), "distinct folding patterns.")
@@ -328,7 +330,7 @@ def clearOEIScache() -> None:
 		return
 	for oeisID in settingsOEIS:
 		( _pathCache / f"{oeisID}.txt" ).unlink(missing_ok=True)
-		( _pathCache / _getFilenameOEISbFile(oeisID) ).unlink(missing_ok=True)
+		( _pathCache / getFilenameOEISbFile(oeisID) ).unlink(missing_ok=True)
 	print(f"Cache cleared from {_pathCache}")
 
 def getOEISids() -> None:

mapFolding/someAssemblyRequired/makeJob.py

@@ -1,14 +1,15 @@
+from collections.abc import Sequence
 from mapFolding import getPathFilenameFoldsTotal, computationState, outfitCountFolds, getAlgorithmSource
+from pathlib import Path
 from types import ModuleType
-from typing import Any, Literal, Optional, Sequence, overload
-import pathlib
+from typing import Any, Literal, overload
 import pickle
 
 @overload
-def makeStateJob(listDimensions: Sequence[int], *, writeJob: Literal[True] , **keywordArguments: Optional[str]) -> pathlib.Path: ...
+def makeStateJob(listDimensions: Sequence[int], *, writeJob: Literal[True] , **keywordArguments: str | None) -> Path: ...
 @overload
-def makeStateJob(listDimensions: Sequence[int], *, writeJob: Literal[False] , **keywordArguments: Optional[str]) -> computationState: ...
-def makeStateJob(listDimensions: Sequence[int], *, writeJob: bool = True, **keywordArguments: Optional[Any]) -> computationState | pathlib.Path:
+def makeStateJob(listDimensions: Sequence[int], *, writeJob: Literal[False] , **keywordArguments: str | None) -> computationState: ...
+def makeStateJob(listDimensions: Sequence[int], *, writeJob: bool = True, **keywordArguments: Any | None) -> computationState | Path:
 	"""
 	Creates a computation state job for map folding calculations and optionally saves it to disk.
 
@@ -27,7 +28,7 @@ def makeStateJob(listDimensions: Sequence[int], *, writeJob: bool = True, **keyw
 
 	Returns
 	-------
-	Union[computationState, pathlib.Path]
+	Union[computationState, Path]
 		If writeJob is False, returns the computation state object.
 		If writeJob is True, returns the Path object pointing to the saved state file.
 
@@ -47,7 +48,7 @@ def makeStateJob(listDimensions: Sequence[int], *, writeJob: bool = True, **keyw
 
 	pathFilenameChopChop = getPathFilenameFoldsTotal(stateUniversal['mapShape'])
 	suffix = pathFilenameChopChop.suffix
-	pathJob = pathlib.Path(str(pathFilenameChopChop)[0:-len(suffix)])
+	pathJob = Path(str(pathFilenameChopChop)[0:-len(suffix)])
 	pathJob.mkdir(parents=True, exist_ok=True)
 	pathFilenameJob = pathJob / 'stateJob.pkl'
 

mapFolding/someAssemblyRequired/synthesizeModuleJAX.py

@@ -1,15 +1,13 @@
 from mapFolding import getAlgorithmSource, getPathSyntheticModules
 from mapFolding import setDatatypeModule, setDatatypeFoldsTotal, setDatatypeElephino, setDatatypeLeavesTotal
-from typing import Optional
 import ast
 import inspect
 import pathlib
-import sys
 
 def transformPythonToJAX(codePython: str) -> None:
 	astPython = ast.parse(codePython)
 
-def writeJax(*, codeSource: Optional[str] = None, pathFilenameAlgorithm: Optional[pathlib.Path] = None, pathFilenameDestination: Optional[pathlib.Path] = None) -> None:
+def writeJax(*, codeSource: str | None = None, pathFilenameAlgorithm: pathlib.Path | None = None, pathFilenameDestination: pathlib.Path | None = None) -> None:
 	if codeSource is None and pathFilenameAlgorithm is None:
 		algorithmSource = getAlgorithmSource()
 		codeSource = inspect.getsource(algorithmSource)