slc.zopescript 1.1.4

Console Script

To create a console script, i.e a script that you can run standalone from a terminal, you can derive a class from slc.zopescript.script.ConsoleScript and implement the run() method. The Zope app will be available as self.app and the first Plone Site as self.portal. If you pass a context_path then self.context will be the object represented by this path; otherwise self.context will be the portal as well. A request will be set up so that you can e.g. call browser views. Example:

from my.egg import MailHandler
from slc.zopescript.script import ConsoleScript


class MailHandlerScript(ConsoleScript):
    def run(self):
        mailhandler_view = MailHandler(self.context, self.context.REQUEST)
        mailhandler_view()

mail_handler = MailHandlerScript()

In your buildout you can generate the console script e.g. with zc.recipe.egg:

[mail_handler]
recipe = zc.recipe.egg
eggs = ${instance:eggs}
scripts = mail_handler
arguments = '${instance:location}/etc/zope.conf','admin',server_url='http://localhost:8081/Plone',context_path='/Plone/news'

The first argument must be the path to a valid zope.conf file. The second argument is the user to run the script as. The optional server_url should be the URL under which your site is externally reachable and allows you to use meaningful absolute_url() calls. The optional context_path is the path to an object that will be available as self.context in your script class.

Instance Script

To create an instance script, i.e. a script that you can pass to a zope instance via instance run my_script.py, you can derive a class from slc.zopescript.script.InstanceScript and implement the run() method. The behaviour is similar to ConsoleScript, except that it doesn’t set up the app object but expects it to be passed in when it is instantiated. Example:

from my.egg import MailHandler
from slc.zopescript.script import InstanceScript


class MailHandlerScript(InstanceScript):
    def run(self):
        mailhandler_view = MailHandler(self.context, self.context.REQUEST)
        mailhandler_view()


if "app" in locals():
    mail_handler = MailHandlerScript(app)
    mail_handler('admin', server_url='http://localhost:8081/Plone', context_path='/Plone/news')

Save this code as e.g. mail_handler.py and call it with instance run mail_handler.py. No buildout configuration is necessary. The arguments for the call in the last line are the same as the ones you pass in the arguments option for the console script, except that no zope.conf file can be passed. :orphan:

1.1.4 (2021-11-30)

• Fix for Unauthorized on transaction commit. [reinhardt]

1.1.3 (2021-10-07)

• Support for older Plone/Zope versions. [reinhardt]

• Prevent the log level getting set to DEBUG [goibhniu]

1.1.2 (2021-02-15)

• Support for WSGI. [reinhardt]

1.1.1 (2021-02-15)

• ZCML namespace cleanup. [thet]

1.1.0 (2019-01-28)

• Added InstanceScript class for use with instance run. [reinhardt]

1.0.4 (2017-08-29)

• Improve log handling:

  • only log errors during startup

  • log INFO to stdout

  • log ERROR to stderr

  • log to instance’s event.log too

  This makes it possible to only escalate errors in cronjobs, send normal logging to /dev/null and protocol what has been done in the instance.log

  [frisi]

1.0.3 (2016-05-19)

• traverse to context as run_as user [reinhardt]

• Allow selecting a portal by id [reinhardt]

1.0.2 (2016-03-18)

• better manifest [reinhardt]

1.0.1 (2016-03-18)

• Allow passing a context_path [reinhardt]

• Updated README [reinhardt]

1.0 (2015-12-11)

• Initial release. [reinhardt]

orphan: