methodcard.registry

The registry of every method card, filled on import and keyed by qualified name.

Classes

Name	Description
Entry	A registered method: the object, its card and what only exists at runtime.

Functions

Name	Description
card	The card of a registered class or function (it renders in Jupyter).
entries	The registered entries, of one top-level package or of all.
load	Import a package and all its submodules, so that every card is registered.
qualified_name	<module>.<qualname> of a class or function.
register	Add an entry; a name registered twice (a module reloaded) is replaced.
registry	The registered classes and functions, of one top-level package or of all.
summary	The first line of the object's own docstring.

Entryclassdataclass#

View source

class Entry(obj: Any, card: MethodCard, symbolic: Mapping[str, Any] | Callable[[], Mapping[str, Any]] = dict(), problem: Callable[[], Any] | None = None)

A registered method: the object, its card and what only exists at runtime.

Attributes

Name	Type	Description
obj	Any	The class or function.
card	MethodCard	Its card.
symbolic	Mapping[str, Any] | Callable[[], Mapping[str, Any]]	SymPy rules by equation key (:class:~methodcard.Rule or bare expressions), or a function returning them.
problem	Callable[[], Any] | None	Returns the :class:~methodcard.ConvergenceProblem of the method.

cardattributeinstance attribute#

View source

card: MethodCard

objattributeinstance attribute#

View source

obj: Any

problemattributeclass attributeinstance attribute#

View source

problem: Callable[[], Any] | None = None

symbolicattributeclass attributeinstance attribute#

View source

symbolic: Mapping[str, Any] | Callable[[], Mapping[str, Any]] = field(default_factory=dict)

packageproperty#

View source

package: str

The top-level package the method belongs to.

rulesmethod#

View source

def rules() -> Mapping[str, Any]

The SymPy rules, calling the function that returns them if need be.

cardfunction#

View source

def card(obj: Any) -> MethodCard

The card of a registered class or function (it renders in Jupyter).

Raises

LookupError

If the object has no card.

entriesfunction#

View source

def entries(package: str | None = None) -> dict[str, Entry]

The registered entries, of one top-level package or of all.

Parameters

Name	Type	Default	Description
package	str | None	None	The top-level package, e.g. "freeofcharge"; None for all.

Returns

dict[str, Entry]

A copy of the registry, {qualified name: entry}.

loadfunction#

View source

def load(package: str) -> dict[str, BaseException]

Import a package and all its submodules, so that every card is registered.

Modules in a tests subpackage are skipped.

Parameters

Name	Type	Description
package	str	The top-level package.

Returns

dict[str, BaseException]

The modules that failed to import, with their errors.

qualified_namefunction#

View source

def qualified_name(obj: Any) -> str

<module>.<qualname> of a class or function.

registerfunction#

View source

def register(entry: Entry) -> None

Add an entry; a name registered twice (a module reloaded) is replaced.

registryfunction#

View source

def registry(package: str | None = None) -> dict[str, Any]

The registered classes and functions, of one top-level package or of all.

summaryfunction#

View source

def summary(obj: Any) -> str

The first line of the object’s own docstring.