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

mapFolding/__init__.py

@@ -1,69 +1,104 @@
+from collections import defaultdict
+from types import ModuleType
+import importlib
+
+_dictionaryListsImportFrom: dict[str, list[str]] = defaultdict(list)
+
+def __getattr__(name: str):
+	if name not in _mapSymbolToModule:
+		raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
+
+	try:
+		moduleAsStr: str = _mapSymbolToModule[name]
+		module: ModuleType =  importlib.import_module(moduleAsStr)
+		blankSymbol = getattr(module, name)
+	except (ImportError, ModuleNotFoundError, AttributeError):
+		raise
+
+	# The need to inject into globals tells us that the symbol has not actually been imported
+	globals()[name] = blankSymbol
+	return blankSymbol
+
+_dictionaryListsImportFrom['mapFolding.basecamp'].extend([
+	'countFolds',
+])
+
+_dictionaryListsImportFrom['mapFolding.beDRY'].extend([
+	'getFilenameFoldsTotal',
+	'getPathFilenameFoldsTotal',
+	'outfitCountFolds',
+	'saveFoldsTotal',
+])
+
+_dictionaryListsImportFrom['mapFolding.oeis'].extend([
+	'clearOEIScache',
+	'getOEISids',
+	'oeisIDfor_n',
+])
+
 # fundamentals
-from mapFolding.theSSOT import (
-	computationState,
-	EnumIndices,
-	getDispatcherCallable,
-	getPathPackage,
-	indexMy,
-	indexTrack,
-	myPackageNameIs,
-)
+_dictionaryListsImportFrom['mapFolding.theSSOT'].extend([
+	'computationState',
+	'EnumIndices',
+	'getDispatcherCallable',
+	'getPathPackage',
+	'indexMy',
+	'indexTrack',
+	'myPackageNameIs',
+])
 
 # Datatype management
-from mapFolding.theSSOT import (
-	getDatatypeModule,
-	hackSSOTdatatype,
-	hackSSOTdtype,
-	setDatatypeElephino,
-	setDatatypeFoldsTotal,
-	setDatatypeLeavesTotal,
-	setDatatypeModule,
-)
+_dictionaryListsImportFrom['mapFolding.theSSOT'].extend([
+	'getDatatypeModule',
+	'hackSSOTdatatype',
+	'hackSSOTdtype',
+	'setDatatypeElephino',
+	'setDatatypeFoldsTotal',
+	'setDatatypeLeavesTotal',
+	'setDatatypeModule',
+])
 
 # Synthesize modules
-from mapFolding.theSSOT import (
-	formatFilenameModuleDEFAULT,
-	getAlgorithmDispatcher,
-	getAlgorithmSource,
-	getPathJobRootDEFAULT,
-	getPathSyntheticModules,
-	moduleOfSyntheticModules,
-	Z0Z_getDatatypeModuleScalar,
-	Z0Z_getDecoratorCallable,
-	Z0Z_setDatatypeModuleScalar,
-	Z0Z_setDecoratorCallable,
-	Z0Z_identifierCountFolds,
-)
+_dictionaryListsImportFrom['mapFolding.theSSOT'].extend([
+	'formatFilenameModuleDEFAULT',
+	'getAlgorithmDispatcher',
+	'getAlgorithmSource',
+	'getPathJobRootDEFAULT',
+	'getPathSyntheticModules',
+	'moduleOfSyntheticModules',
+	'Z0Z_getDatatypeModuleScalar',
+	'Z0Z_getDecoratorCallable',
+	'Z0Z_setDatatypeModuleScalar',
+	'Z0Z_setDecoratorCallable',
+	'Z0Z_identifierCountFolds',
+])
 
 # Parameters for the prima donna
-from mapFolding.theSSOT import (
-	ParametersNumba,
-	parametersNumbaDEFAULT,
-	parametersNumbaFailEarly,
-	parametersNumbaMinimum,
-	parametersNumbaParallelDEFAULT,
-	parametersNumbaSuperJit,
-	parametersNumbaSuperJitParallel,
-)
+_dictionaryListsImportFrom['mapFolding.theSSOT'].extend([
+	'ParametersNumba',
+	'parametersNumbaDEFAULT',
+	'parametersNumbaFailEarly',
+	'parametersNumbaMinimum',
+	'parametersNumbaParallelDEFAULT',
+	'parametersNumbaSuperJit',
+	'parametersNumbaSuperJitParallel',
+])
 
 # Coping
-from mapFolding.theSSOT import (
-	FREAKOUT,
-)
-
-from mapFolding.beDRY import (
-	getFilenameFoldsTotal,
-	getPathFilenameFoldsTotal,
-	outfitCountFolds,
-	saveFoldsTotal,
-)
+_dictionaryListsImportFrom['mapFolding.theSSOT'].extend([
+	'FREAKOUT',
+])
 
-from mapFolding.basecamp import countFolds
-from mapFolding.oeis import clearOEIScache, getOEISids, oeisIDfor_n
+_mapSymbolToModule: dict[str, str] = {}
+for moduleAsStr, listSymbolsAsStr in _dictionaryListsImportFrom.items():
+	for symbolAsStr in listSymbolsAsStr:
+		_mapSymbolToModule[symbolAsStr] = moduleAsStr
 
-__all__: list[str] = [
-	'clearOEIScache',
-	'countFolds',
-	'getOEISids',
-	'oeisIDfor_n',
-]
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+	from basecamp import *
+	from beDRY import *
+	from oeis import *
+	from theDao import *
+	from theSSOT import *
+	from theSSOTdatatypes import *

mapFolding/basecamp.py

@@ -3,11 +3,11 @@ from mapFolding import computationState, getDispatcherCallable, getPathFilenameF
 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
+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.
 

mapFolding/beDRY.py

@@ -13,7 +13,7 @@ from mapFolding import (
 	setDatatypeModule,
 )
 from collections.abc import Sequence
-from numba import get_num_threads, set_num_threads
+from numba import get_num_threads, set_num_threads # type: ignore
 from numpy import dtype, integer, ndarray
 from numpy.typing import DTypeLike, NDArray
 from pathlib import Path
@@ -139,7 +139,7 @@ def getTaskDivisions(computationDivisions: int | str | None, concurrencyLimit: i
 		pass
 	elif isinstance(computationDivisions, int):
 		taskDivisions = computationDivisions
-	elif isinstance(computationDivisions, str):
+	elif isinstance(computationDivisions, str):  # type: ignore 'Unnecessary isinstance call; "str" is always an instance of "str", so sayeth Pylance'. Yeah, well "User is not always an instance of "correct input" so sayeth the programmer.
 		computationDivisions = computationDivisions.lower()
 		if computationDivisions == 'maximum':
 			taskDivisions = leavesTotal
@@ -298,8 +298,8 @@ def parseDimensions(dimensions: Sequence[int], parameterName: str = 'listDimensi
 		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 = []
+	listValidated: list[int] = intInnit(dimensions, parameterName)
+	listNonNegative: list[int] = []
 	for dimension in listValidated:
 		if dimension < 0:
 			raise ValueError(f"Dimension {dimension} must be non-negative")
@@ -357,7 +357,7 @@ def setCPUlimit(CPUlimit: Any | None) -> int:
 
 	concurrencyLimit = int(defineConcurrencyLimit(CPUlimit))
 	set_num_threads(concurrencyLimit)
-	concurrencyLimit = get_num_threads()
+	concurrencyLimit: int = get_num_threads()
 
 	return concurrencyLimit
 

mapFolding/oeis.py

@@ -5,6 +5,7 @@ from mapFolding import countFolds, getPathPackage
 from typing import Any, Final, TYPE_CHECKING
 import argparse
 import pathlib
+from pathlib import Path
 import random
 import sys
 import time
@@ -22,7 +23,7 @@ cacheDays = 7
 """
 Section: make `settingsOEIS`"""
 
-_pathCache = getPathPackage() / ".cache"
+_pathCache: Path = getPathPackage() / ".cache"
 
 class SettingsOEIS(TypedDict):
 	description: str
@@ -91,7 +92,7 @@ def validateOEISid(oeisIDcandidate: str) -> str:
 	if oeisIDcandidate in oeisIDsImplemented:
 		return oeisIDcandidate
 	else:
-		oeisIDcleaned = str(oeisIDcandidate).upper().strip()
+		oeisIDcleaned: str = str(oeisIDcandidate).upper().strip()
 		if oeisIDcleaned in oeisIDsImplemented:
 			return oeisIDcleaned
 		else:
@@ -123,12 +124,12 @@ def _parseBFileOEIS(OEISbFile: str, oeisID: str) -> dict[int, int]:
 		ValueError: If the first line of the file does not indicate the expected
 		sequence ID or if the content format is invalid.
 	"""
-	bFileLines = OEISbFile.strip().splitlines()
+	bFileLines: list[str] = OEISbFile.strip().splitlines()
 	if not bFileLines.pop(0).startswith(f"# {oeisID}"):
 		warnings.warn(f"Content does not match sequence {oeisID}")
 		return {-1: -1}
 
-	OEISsequence = {}
+	OEISsequence: dict[int, int] = {}
 	for line in bFileLines:
 		if line.startswith('#'):
 			continue
@@ -139,10 +140,10 @@ def _parseBFileOEIS(OEISbFile: str, oeisID: str) -> dict[int, int]:
 def getOEISofficial(pathFilenameCache: pathlib.Path, url: str) -> None | str:
 	tryCache = False
 	if pathFilenameCache.exists():
-		fileAge = datetime.now() - datetime.fromtimestamp(pathFilenameCache.stat().st_mtime)
-		tryCache = fileAge < timedelta(days=cacheDays)
+		fileAge: timedelta = datetime.now() - datetime.fromtimestamp(pathFilenameCache.stat().st_mtime)
+		tryCache: bool = fileAge < timedelta(days=cacheDays)
 
-	oeisInformation = None
+	oeisInformation: str | None = None
 	if tryCache:
 		try:
 			oeisInformation = pathFilenameCache.read_text()
@@ -179,10 +180,10 @@ 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: Path = _pathCache / getFilenameOEISbFile(oeisID)
+	url: str = f"https://oeis.org/{oeisID}/{getFilenameOEISbFile(oeisID)}"
 
-	oeisInformation = getOEISofficial(pathFilenameCache, url)
+	oeisInformation: None | str = getOEISofficial(pathFilenameCache, url)
 
 	if oeisInformation:
 		return _parseBFileOEIS(oeisInformation, oeisID)
@@ -190,15 +191,15 @@ def getOEISidValues(oeisID: str) -> dict[int, int]:
 
 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"
+	pathFilenameCache: Path = _pathCache / f"{oeisID}.txt"
+	url: str = f"https://oeis.org/search?q=id:{oeisID}&fmt=text"
 
-	oeisInformation = getOEISofficial(pathFilenameCache, url)
+	oeisInformation: None | str = getOEISofficial(pathFilenameCache, url)
 
 	if not oeisInformation:
 		return "Not found", -1
 
-	description_parts = []
+	description_parts: list[str] = []
 	offset = None
 	for line in oeisInformation.splitlines():
 		if line.startswith('%N'):
@@ -207,9 +208,9 @@ def getOEISidInformation(oeisID: str) -> tuple[str, int]:
 				desc_part = ' '.join(parts[2:])
 				description_parts.append(desc_part)
 		elif line.startswith('%O'):
-			parts = line.split()
+			parts: list[str] = line.split()
 			if parts[1] == oeisID:
-				offset_str = parts[2].split(',')[0]
+				offset_str: str = parts[2].split(',')[0]
 				offset = int(offset_str)
 	if not description_parts:
 		warnings.warn(f"No description found for {oeisID}")
@@ -217,13 +218,13 @@ def getOEISidInformation(oeisID: str) -> tuple[str, int]:
 	if offset is None:
 		warnings.warn(f"No offset found for {oeisID}")
 		offset = -1
-	description = ' '.join(description_parts)
+	description: str = ' '.join(description_parts)
 	return description, offset
 
 def makeSettingsOEIS() -> dict[str, SettingsOEIS]:
-	settingsTarget = {}
+	settingsTarget: dict[str, SettingsOEIS] = {}
 	for oeisID in oeisIDsImplemented:
-		valuesKnownSherpa = getOEISidValues(oeisID)
+		valuesKnownSherpa: dict[int, int] = getOEISidValues(oeisID)
 		descriptionSherpa, offsetSherpa = getOEISidInformation(oeisID)
 		settingsTarget[oeisID] = SettingsOEIS(
 			description=descriptionSherpa,
@@ -245,8 +246,8 @@ Section: private functions"""
 
 def _formatHelpText() -> str:
 	"""Format standardized help text for both CLI and interactive use."""
-	exampleOEISid = oeisIDsImplemented[0]
-	exampleN = settingsOEIS[exampleOEISid]['valuesTestValidation'][-1]
+	exampleOEISid: str = oeisIDsImplemented[0]
+	exampleN: int = settingsOEIS[exampleOEISid]['valuesTestValidation'][-1]
 
 	return (
 		"\nAvailable OEIS sequences:\n"
@@ -269,7 +270,7 @@ def _formatOEISsequenceInfo() -> str:
 """
 Section: public functions"""
 
-def oeisIDfor_n(oeisID: str, n: int) -> int:
+def oeisIDfor_n(oeisID: str, n: int | Any) -> int:
 	"""
 	Calculate a(n) of a sequence from "The On-Line Encyclopedia of Integer Sequences" (OEIS).
 
@@ -292,10 +293,10 @@ def oeisIDfor_n(oeisID: str, n: int) -> int:
 	listDimensions: list[int] = settingsOEIS[oeisID]['getMapShape'](n)
 
 	if n <= 1 or len(listDimensions) < 2:
-		offset = settingsOEIS[oeisID]['offset']
+		offset: int = settingsOEIS[oeisID]['offset']
 		if n < offset:
 			raise ArithmeticError(f"OEIS sequence {oeisID} is not defined at n={n}.")
-		foldsTotal = settingsOEIS[oeisID]['valuesKnown'][n]
+		foldsTotal: int = settingsOEIS[oeisID]['valuesKnown'][n]
 		return foldsTotal
 
 	return countFolds(listDimensions)
@@ -320,7 +321,7 @@ def OEIS_for_n() -> None:
 		print(f"Error: {ERRORmessage}", file=sys.stderr)
 		sys.exit(1)
 
-	timeElapsed = time.perf_counter() - timeStart
+	timeElapsed: float = time.perf_counter() - timeStart
 	print(f"Time elapsed: {timeElapsed:.3f} seconds")
 
 def clearOEIScache() -> None:

mapFolding/theSSOT.py

@@ -1,18 +1,5 @@
 from collections.abc import Callable
-from mapFolding.theSSOTdatatypes import (
-	EnumIndices,
-	indexMy,
-	indexTrack,
-	reportDatatypeLimit,
-	setDatatypeModule,
-	setDatatypeElephino,
-	setDatatypeFoldsTotal,
-	setDatatypeLeavesTotal,
-	getDatatypeModule,
-	setInStone,
-	hackSSOTdtype,
-	hackSSOTdatatype,
-)
+from mapFolding.theSSOTdatatypes import *
 from numba.core.compiler import CompilerBase as numbaCompilerBase
 from numpy import dtype, integer, ndarray
 from pathlib import Path
@@ -45,6 +32,7 @@ myPackageNameIs = "mapFolding"
 moduleOfSyntheticModules = "syntheticModules"
 # TODO I'm not sure if this is the right tool for the job.
 formatFilenameModuleDEFAULT = "numba_{callableTarget}.py"
+# TODO figure out how to implement this
 dispatcherCallableNameDEFAULT = "doTheNeedful"
 
 def getPathPackage() -> Path:
@@ -133,7 +121,7 @@ class ParametersNumba(TypedDict):
 	nopython: bool
 	parallel: bool
 	pipeline_class: NotRequired[type[numbaCompilerBase]]
-	signature_or_function: NotRequired[Any | Callable | str | tuple]
+	signature_or_function: NotRequired[Any | Callable[..., Any] | str | tuple[Any, ...]]
 	target: NotRequired[str]
 
 parametersNumbaFailEarly: Final[ParametersNumba] = { '_nrt': True, 'boundscheck': True, 'cache': True, 'error_model': 'python', 'fastmath': False, 'forceinline': True, 'inline': 'always', 'looplift': False, 'no_cfunc_wrapper': False, 'no_cpython_wrapper': False, 'nopython': True, 'parallel': False, }

mapFolding/theSSOTdatatypes.py

@@ -1,18 +1,8 @@
 from collections import defaultdict
-from typing import Any, cast, Final, TYPE_CHECKING
+from typing import Any, cast, Final
 import enum
-import numba
-import numpy
-
-try:
-	from typing import NotRequired
-except Exception:
-	from typing_extensions import NotRequired # type: ignore
-
-if TYPE_CHECKING:
-	from typing import TypedDict
-else:
-	TypedDict = dict
+import numba # type: ignore
+import numpy # type: ignore
 
 class EnumIndices(enum.IntEnum):
 	@staticmethod
@@ -51,7 +41,7 @@ _datatypeDefault: Final[dict[str, str]] = {
 	'foldsTotal': 'int64',
 	'leavesTotal': 'uint16',
 }
-_datatypeModule = ''
+_datatypeModule: str = ''
 _datatypeModuleDEFAULT: Final[str] = 'numpy'
 
 _datatype: dict[str, str] = defaultdict(str)
@@ -103,12 +93,12 @@ def getDatatypeModule() -> str:
 	return _datatypeModule
 
 def setInStone(identifier: str) -> type[Any]:
-	datatypeModule = getDatatypeModule()
-	datatypeStr = _get_datatype(identifier)
+	datatypeModule: str = getDatatypeModule()
+	datatypeStr: str = _get_datatype(identifier)
 	return cast(type[Any], getattr(eval(datatypeModule), datatypeStr))
 
 def hackSSOTdtype(identifier: str) -> type[Any]:
-	_hackSSOTdtype={
+	_hackSSOTdtype: dict[str, str]={
 	'connectionGraph': 	'dtypeLeavesTotal',
 	'dtypeElephino': 	'dtypeElephino',
 	'dtypeFoldsTotal': 	'dtypeFoldsTotal',
@@ -119,7 +109,7 @@ def hackSSOTdtype(identifier: str) -> type[Any]:
 	'my': 				'dtypeElephino',
 	'track': 			'dtypeElephino',
 	}
-	RubeGoldBerg = _hackSSOTdtype[identifier]
+	RubeGoldBerg: str = _hackSSOTdtype[identifier]
 	if RubeGoldBerg == 'dtypeElephino':
 		return setInStone('elephino')
 	elif RubeGoldBerg == 'dtypeFoldsTotal':
@@ -129,7 +119,7 @@ def hackSSOTdtype(identifier: str) -> type[Any]:
 	raise Exception("Dude, you forgot to set a value in `hackSSOTdtype`.")
 
 def hackSSOTdatatype(identifier: str) -> str:
-	_hackSSOTdatatype={
+	_hackSSOTdatatype: dict[str, str]={
 	'connectionGraph':	 		'datatypeLeavesTotal',
 	'countDimensionsGapped': 	'datatypeLeavesTotal',
 	'datatypeElephino': 		'datatypeElephino',
@@ -156,7 +146,7 @@ def hackSSOTdatatype(identifier: str) -> str:
 	'taskIndex': 				'datatypeLeavesTotal',
 	'track':	 				'datatypeElephino',
 	}
-	RubeGoldBerg = _hackSSOTdatatype[identifier]
+	RubeGoldBerg: str = _hackSSOTdatatype[identifier]
 	if RubeGoldBerg == 'datatypeElephino':
 		return _get_datatype('elephino')
 	elif RubeGoldBerg == 'datatypeFoldsTotal':

{mapFolding-0.5.0.dist-info → mapFolding-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mapFolding
-Version: 0.5.0
+Version: 0.5.1
 Summary: Count distinct ways to fold a map (or a strip of stamps)
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 License: CC-BY-NC-4.0
@@ -33,6 +33,7 @@ Requires-Dist: numpy
 Requires-Dist: Z0Z_tools
 Provides-Extra: testing
 Requires-Dist: autoflake; extra == "testing"
+Requires-Dist: mypy; extra == "testing"
 Requires-Dist: more_itertools; extra == "testing"
 Requires-Dist: pytest-cov; extra == "testing"
 Requires-Dist: pytest-env; extra == "testing"

mapFolding-0.5.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+mapFolding/__init__.py,sha256=FmpYlbGIZ4Pkt5Qr49JRBWdPRX9be4dYNlEV1ZXkmKU,2620
+mapFolding/basecamp.py,sha256=eU-9XQ9aOpgOcpVSTlbQ_XZEYsmfx1h6gESTgvP3RrI,3707
+mapFolding/beDRY.py,sha256=_NswGMIkF77akOSEJQqbOQOMwwrAL0c9yJi5bTZUBzw,17027
+mapFolding/oeis.py,sha256=ekXTb5P2GUkVgVsxWb23nukl8Pg97kdyU3-pePq7EQA,11393
+mapFolding/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mapFolding/theDao.py,sha256=64dlLhrdtNbZAXMbqcZhGAE0ZwgqYRt8nT1on46J-cc,12611
+mapFolding/theSSOT.py,sha256=u7VXbqGasrTomxI771bQ7kURMpfn_ph6Y8ac8Rf70hw,5866
+mapFolding/theSSOTdatatypes.py,sha256=-p9B5ikWPKqztnmDDg6NKAdys7qwiNU2c1oCbGXAf5Q,5714
+mapFolding-0.5.1.dist-info/LICENSE,sha256=NxH5Y8BdC-gNU-WSMwim3uMbID2iNDXJz7fHtuTdXhk,19346
+mapFolding-0.5.1.dist-info/METADATA,sha256=UJsh0vVsMCGhX3ORFIrrVCLSQDDGJeGC_QrUjJeKpB4,7718
+mapFolding-0.5.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+mapFolding-0.5.1.dist-info/entry_points.txt,sha256=F3OUeZR1XDTpoH7k3wXuRb3KF_kXTTeYhu5AGK1SiOQ,146
+mapFolding-0.5.1.dist-info/top_level.txt,sha256=aG3bjFBoxxuaV3Iu1wZAd241Ubs3cdaJtKYBQBDIjsg,11
+mapFolding-0.5.1.dist-info/RECORD,,

{mapFolding-0.5.0.dist-info → mapFolding-0.5.1.dist-info}/top_level.txt

@@ -1,2 +1 @@
 mapFolding
-tests