Xmod: Turn any object into a module

Warnings

• gotcha When explicitly providing the `name` argument to `xmod()`, it should almost always be set to `__name__`. Using a different string can lead to unexpected module aliasing or inconsistent behavior within `sys.modules`.
  Fix: For typical module extension, ensure `xmod(..., name=__name__)` is used. Only deviate if you have an advanced use case requiring specific `sys.modules` manipulation.
• gotcha Combining `xmod` with `functools.partial` can sometimes lead to unexpected behavior. Since version `1.3.2`, `xmod` will raise a clear exception if `functools.partial` is used in a way it doesn't support, to prevent silent failures.
  Fix: If an exception related to `functools.partial` is raised, adjust your approach as indicated by the error message. Consider alternative partial application techniques or consult `xmod`'s documentation for compatible patterns.
• gotcha Using `xmod(..., full=True)` extends the module with *all* members of the extension object, which might unintentionally overwrite existing module attributes. Additionally, `xmod(..., mutable=True)` allows runtime modification of the module's attributes via the `xmod` proxy, potentially introducing hard-to-debug state changes.
  Fix: Be selective about attribute exposure; prefer `full=False` and explicitly expose only what's necessary. Understand the implications of mutable module state before setting `mutable=True` and favor immutable extensions where possible.

Install

• pip install xmod Install stable version

Imports

• xmod

  import xmod

Quickstart

The most common usage is to decorate a function within a module to make the module itself callable. This example demonstrates making the module 'your_module' callable, returning a greeting.

# In your_module.py
import xmod

@xmod
def greet():
    return 'Hello from your_module!'

# To test in another script or interpreter:
# import your_module
# print(your_module())
# Expected output: Hello from your_module!