megrok.strictrequire 5.0

Checks that all grokked "view-like" components require a permission.

megrok.strictrequire

What is megrok.strictrequire?

Strictrequire implements additional grokkers for the various view components in Grok. These grokkers determine whether the grok.require directive has been explicitly set on the view component (or on its baseclass).

It will raise an error (and thus prevent the startup of the application) if there’s a view component without an explicit use of the grok.require directive, providing a minimal safety net for finding unprotected views in your application.

Making use of megrok.strictrequire

To enable megrok.strictrequire simply list it as a requirement in your projects’s setup.py. Grok based applications that were bootstrapped with a recent version of the grokproject command will automatically include the megrok.strictrequire’s configure.zcml making the additional grokkers effective.

Caveat

If your applications triggers the registration of “third-party” views that do not themselves specifically use the grok.require directive, your application will not start.

If you decide you still want to make use of the third-aprty views you should make sure the inclusion of the configure.zcml of megrok.strictrequire comes after the inclusion of the third-party package by tweaking your applications’s configure.zcml. For example:

<configure xmlns="http://namespaces.zope.org/zope"
           xmlns:grok="http://namespaces.zope.org/grok">
  <include package="grok" />

  <!-- include this package before mgrok.strictrequire is included -->
  <include package="package_with_unprotected_views" />

  <!-- includeDependencies will include megrok.strictrequire -->
  <includeDependencies package="." />
  <grok:grok package="." />
</configure>

Changelog of megrok.strictrequire

5.0 (2024-03-22)

• Drop support for explicit (pkg_resources) namespaces and replace it with an implicit (PEP 420) namespace.

4.0 (2024-01-25)

• Drop support for Python 2.7, 3.4, 3.5, 3.6.

• Drop support for grok < 5, thus dropping support for JSON, REST and XMLRPC.

• Add support for Python 3.7, 3.8, 3.9, 3.10, 3.11, 3.12.

3.0.0 (2018-01-17)

• Python 3 compatibility.

0.7 (2018-01-10)

• Dependencies update in preparation of Python2/3 migration.

0.6 (2013-10-16)

• Add grokker for grok.Page components.

0.5 (2011-07-19)

• Reflect recent changes in grok 1.8.

0.4 (2011-07-11)

• Use the groktoolkit versions.

• Don’t check the requirement directive for ViewletManager, as these are not exposed as views.

0.3 (2010-05-18)

• Test-requirements have been fixed. They formally include zope.app.testing for the moment.

0.2 (2009-06-22)

• Check ViewletManager and Viewlet components too.

0.1 (2009-06-18)

• Initial release.