cement.ext.ext_dummy

Cement dummy extension module.

class cement.ext.ext_dummy.DummyMailHandler(**kw: Any)

Bases: MailHandler

This class implements the cement.core.mail.IMail interface, but is intended for use in development as no email is actually sent.

Example:

class MyApp(App):
    class Meta:
        label = 'myapp'
        mail_handler = 'dummy'

with MyApp() as app:
    app.run()

    app.mail.send('This is my fake message',
        subject='This is my subject',
        to=['john@example.com', 'rita@example.com'],
        from_addr='me@example.com',
        )

The above will print the following to console:

======================================================================
DUMMY MAIL MESSAGE
----------------------------------------------------------------------

To: john@example.com, rita@example.com
From: me@example.com
CC:
BCC:
Subject: This is my subject

---

This is my fake message

----------------------------------------------------------------------

Configuration

This handler supports the following configuration settings:

• to - Default to addresses (list, or comma separated depending on the ConfigHandler in use)

• from_addr - Default from_addr address

• cc - Default cc addresses (list, or comma separated depending on the ConfigHandler in use)

• bcc - Default bcc addresses (list, or comma separated depending on the ConfigHandler in use)

• subject - Default subject

• subject_prefix - Additional string to prepend to the subject

You can add these to any application configuration file under a [mail.dummy] section, for example:

~/.myapp.conf

[myapp]

# set the mail handler to use
mail_handler = dummy


[mail.dummy]

# default to addresses (comma separated list)
to = me@example.com

# default from address
from = someone_else@example.com

# default cc addresses (comma separated list)
cc = jane@example.com, rita@example.com

# default bcc addresses (comma separated list)
bcc = blackhole@example.com, someone_else@example.com

# default subject
subject = This is The Default Subject

# additional prefix to prepend to the subject
subject_prefix = MY PREFIX >

class Meta

Bases: Meta

Handler meta-data.

label: str = 'dummy'

Unique identifier for this handler

send(body: str, **kw: Any) → bool

Mimic sending an email message, but really just print what would be sent to console. Keyword arguments override configuration defaults (cc, bcc, etc).

Parameters:

body (str) – The message body to send

Keyword Arguments:

• to (list) – List of recipients (generally email addresses)

• from_addr (str) – Address (generally email) of the sender

• cc (list) – List of CC Recipients

• bcc (list) – List of BCC Recipients

• subject (str) – Message subject line

Returns:

True if message is sent successfully, False otherwise

Return type:

bool

Example

# Using all configuration defaults
app.mail.send('This is my message body')

# Overriding configuration defaults
app.mail.send('My message body'
    to=['john@example.com'],
    from_addr='me@example.com',
    cc=['jane@example.com', 'rita@example.com'],
    subject='This is my subject',
    )

class cement.ext.ext_dummy.DummyOutputHandler(**kw: Any)

Bases: OutputHandler

This class is an internal implementation of the cement.core.output.OutputHandlerBase interface. It does not take any parameters on initialization, and does not actually output anything.

class Meta

Bases: Meta

Handler meta-data

label: str = 'dummy'

The string identifier of this handler.

overridable: bool = False

Whether or not to include dummy as an available to choice to override the output_handler via command line options.

render(data: Dict[str, Any], **kw: Any) → None

This implementation does not actually render anything to output, but rather logs it to the debug facility.

Parameters:

data (dict) – The data dictionary to render.

Keyword Arguments:

template (str) – The template parameter is not used by this implementation at all.

class cement.ext.ext_dummy.DummyTemplateHandler(*args: Any, **kwargs: Any)

Bases: TemplateHandler

This class is an internal implementation of the cement.core.template.TemplateHandlerBase interface. It does not take any parameters on initialization, and does not actually render anything.

class Meta

Bases: Meta

Handler meta-data

label: str = 'dummy'

The string identifier of this handler.

copy(src: str, dest: str, data: Dict[str, Any], force: bool = False, exclude: List[str] | None = None, ignore: List[str] | None = None) → bool

This implementation does not actually copy anything, but rather logs it to the debug facility.

Parameters:

• src (str) – The source template directory.

• dest (str) – The destination directory.

• data (dict) – The data dictionary to render with templates.

render(content: str | bytes, data: Dict[str, Any]) → None

This implementation does not actually render anything, but rather logs it to the debug facility.

Parameters:

• content (str) – The content to render as dictionary

• data (dict) – The data dictionary to render.