smonitor.integrations package#

Submodules#

smonitor.integrations.argdigest module#

smonitor.integrations.argdigest.configure_argdigest(**kwargs)[source]#

Entry point for ArgDigest integration.

Intended usage: centralize ArgDigest diagnostics via smonitor.configure.

Parameters:

kwargs (Any)

smonitor.integrations.core module#

smonitor.integrations.core.emit_from_catalog(entry, *, extra=None, package_root=None, meta=None)[source]#
Parameters:

  • entry (Dict[str, Any])

  • extra (Dict[str, Any] | None)

  • package_root (Path | None)

  • meta (Dict[str, Any] | None)

Return type:

Dict[str, Any]

smonitor.integrations.core.ensure_configured(package_root)[source]#
Parameters:

package_root (Path)

Return type:

None

smonitor.integrations.core.merge_extra(meta, extra)[source]#
Parameters:

  • meta (Dict[str, Any] | None)

  • extra (Dict[str, Any] | None)

Return type:

Dict[str, Any]

smonitor.integrations.core.reset_configured_packages()[source]#

Clears the package configuration memoization cache.

Useful for test suites and dynamic multi-config sessions.

Return type:

None

smonitor.integrations.depdigest module#

smonitor.integrations.depdigest.configure_depdigest(**kwargs)[source]#

Entry point for DepDigest integration.

Intended usage: centralize DepDigest diagnostics via smonitor.configure.

Parameters:

kwargs (Any)

smonitor.integrations.diagnostic module#

exception smonitor.integrations.diagnostic.CatalogException(*, message=None, code=None, extra=None, catalog=None, meta=None)[source]#

Bases: Exception

Base class for exceptions backed by an SMonitor catalog.

Subclasses should define catalog_key.

Parameters:

  • message (Optional[str])

  • code (Optional[str])

  • extra (Optional[Dict[str, Any]])

  • catalog (Optional[Dict[str, Any]])

  • meta (Optional[Dict[str, Any]])

catalog_key: str | None = None#
exception smonitor.integrations.diagnostic.CatalogWarning(*, message=None, code=None, extra=None, catalog=None, meta=None)[source]#

Bases: Warning

Base class for warnings backed by an SMonitor catalog.

Parameters:

  • message (Optional[str])

  • code (Optional[str])

  • extra (Optional[Dict[str, Any]])

  • catalog (Optional[Dict[str, Any]])

  • meta (Optional[Dict[str, Any]])

catalog_key: str | None = None#
class smonitor.integrations.diagnostic.DiagnosticBundle(catalog, meta, package_root)[source]#

Bases: object

A bundle of diagnostic tools for a library integration.

Parameters:

  • catalog (Dict[str, Any])

  • meta (Dict[str, Any])

  • package_root (Path)

resolve(message=None, *, code=None, extra=None)[source]#

Resolves and combines message and hint into a single string.

Parameters:

  • message (str | None)

  • code (str | None)

  • extra (Dict[str, Any] | None)

Return type:

str

warn(message_or_warning, category=None, *, stacklevel=2, extra=None)[source]#
Parameters:

  • message_or_warning (str | Warning)

  • category (Type[Warning] | None)

  • stacklevel (int)

  • extra (Dict[str, Any] | None)

Return type:

None

warn_once(message_or_warning, category=None, *, stacklevel=2, extra=None)[source]#
Parameters:

  • message_or_warning (str | Warning)

  • category (Type[Warning] | None)

  • stacklevel (int)

  • extra (Dict[str, Any] | None)

Return type:

None

smonitor.integrations.molsysmt module#

smonitor.integrations.molsysmt.configure_molsysmt(**kwargs)[source]#

Entry point for MolSysMT integration.

Intended usage: replace molsysmt.logging_setup with smonitor.configure.

Parameters:

kwargs (Any)

Module contents#

exception smonitor.integrations.CatalogException(*, message=None, code=None, extra=None, catalog=None, meta=None)[source]#

Bases: Exception

Base class for exceptions backed by an SMonitor catalog.

Subclasses should define catalog_key.

Parameters:

  • message (Optional[str])

  • code (Optional[str])

  • extra (Optional[Dict[str, Any]])

  • catalog (Optional[Dict[str, Any]])

  • meta (Optional[Dict[str, Any]])

catalog_key: str | None = None#
exception smonitor.integrations.CatalogWarning(*, message=None, code=None, extra=None, catalog=None, meta=None)[source]#

Bases: Warning

Base class for warnings backed by an SMonitor catalog.

Parameters:

  • message (Optional[str])

  • code (Optional[str])

  • extra (Optional[Dict[str, Any]])

  • catalog (Optional[Dict[str, Any]])

  • meta (Optional[Dict[str, Any]])

catalog_key: str | None = None#
class smonitor.integrations.DiagnosticBundle(catalog, meta, package_root)[source]#

Bases: object

A bundle of diagnostic tools for a library integration.

Parameters:

  • catalog (Dict[str, Any])

  • meta (Dict[str, Any])

  • package_root (Path)

resolve(message=None, *, code=None, extra=None)[source]#

Resolves and combines message and hint into a single string.

Parameters:

  • message (str | None)

  • code (str | None)

  • extra (Dict[str, Any] | None)

Return type:

str

warn(message_or_warning, category=None, *, stacklevel=2, extra=None)[source]#
Parameters:

  • message_or_warning (str | Warning)

  • category (Type[Warning] | None)

  • stacklevel (int)

  • extra (Dict[str, Any] | None)

Return type:

None

warn_once(message_or_warning, category=None, *, stacklevel=2, extra=None)[source]#
Parameters:

  • message_or_warning (str | Warning)

  • category (Type[Warning] | None)

  • stacklevel (int)

  • extra (Dict[str, Any] | None)

Return type:

None

smonitor.integrations.emit_from_catalog(entry, *, extra=None, package_root=None, meta=None)[source]#
Parameters:

  • entry (Dict[str, Any])

  • extra (Dict[str, Any] | None)

  • package_root (Path | None)

  • meta (Dict[str, Any] | None)

Return type:

Dict[str, Any]

smonitor.integrations.ensure_configured(package_root)[source]#
Parameters:

package_root (Path)

Return type:

None

smonitor.integrations.merge_extra(meta, extra)[source]#
Parameters:

  • meta (Dict[str, Any] | None)

  • extra (Dict[str, Any] | None)

Return type:

Dict[str, Any]

smonitor.integrations.reset_configured_packages()[source]#

Clears the package configuration memoization cache.

Useful for test suites and dynamic multi-config sessions.

Return type:

None