# HG changeset patch # User Thierry Florac # Date 1516031101 -3600 # Node ID 1d12ff3f036a445e45e88d4a878fec340c2d3e34 # Parent 562bde22e104a371c2220914ca660b21816f8249 New release diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/environment.pickle Binary file src/build/doctrees/environment.pickle has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/install.doctree Binary file src/build/doctrees/install.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/modules.doctree Binary file src/build/doctrees/modules.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_alchemy.zmi.doctree Binary file src/build/doctrees/pyams_alchemy.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_cache.interfaces.doctree Binary file src/build/doctrees/pyams_cache.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_cache.tests.doctree Binary file src/build/doctrees/pyams_cache.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_catalog.tests.doctree Binary file src/build/doctrees/pyams_catalog.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_catalog.zmi.doctree Binary file src/build/doctrees/pyams_catalog.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.association.doctree Binary file src/build/doctrees/pyams_content.component.association.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.extfile.doctree Binary file src/build/doctrees/pyams_content.component.extfile.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.gallery.interfaces.doctree Binary file src/build/doctrees/pyams_content.component.gallery.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.gallery.zmi.doctree Binary file src/build/doctrees/pyams_content.component.gallery.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.illustration.interfaces.doctree Binary file src/build/doctrees/pyams_content.component.illustration.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.links.doctree Binary file src/build/doctrees/pyams_content.component.links.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.links.interfaces.doctree Binary file src/build/doctrees/pyams_content.component.links.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.links.zmi.doctree Binary file src/build/doctrees/pyams_content.component.links.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.media.doctree Binary file src/build/doctrees/pyams_content.component.media.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.paragraph.doctree Binary file src/build/doctrees/pyams_content.component.paragraph.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.component.theme.doctree Binary file src/build/doctrees/pyams_content.component.theme.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.generations.doctree Binary file src/build/doctrees/pyams_content.generations.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.scripts.doctree Binary file src/build/doctrees/pyams_content.scripts.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.blog.doctree Binary file src/build/doctrees/pyams_content.shared.blog.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.blog.interfaces.doctree Binary file src/build/doctrees/pyams_content.shared.blog.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.blog.zmi.doctree Binary file src/build/doctrees/pyams_content.shared.blog.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.form.interfaces.doctree Binary file src/build/doctrees/pyams_content.shared.form.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.imagemap.interfaces.doctree Binary file src/build/doctrees/pyams_content.shared.imagemap.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.imagemap.zmi.doctree Binary file src/build/doctrees/pyams_content.shared.imagemap.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.site.doctree Binary file src/build/doctrees/pyams_content.shared.site.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.site.zmi.doctree Binary file src/build/doctrees/pyams_content.shared.site.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.view.doctree Binary file src/build/doctrees/pyams_content.shared.view.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.view.interfaces.doctree Binary file src/build/doctrees/pyams_content.shared.view.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.shared.view.zmi.doctree Binary file src/build/doctrees/pyams_content.shared.view.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.skin.doctree Binary file src/build/doctrees/pyams_content.skin.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.workflow.zmi.doctree Binary file src/build/doctrees/pyams_content.workflow.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.zmi.doctree Binary file src/build/doctrees/pyams_content.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content.zmi.viewlet.doctree Binary file src/build/doctrees/pyams_content.zmi.viewlet.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content_es.interfaces.doctree Binary file src/build/doctrees/pyams_content_es.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_content_es.scripts.doctree Binary file src/build/doctrees/pyams_content_es.scripts.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_form.doctree Binary file src/build/doctrees/pyams_form.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_form.interfaces.doctree Binary file src/build/doctrees/pyams_form.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_form.tests.doctree Binary file src/build/doctrees/pyams_form.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_form.widget.doctree Binary file src/build/doctrees/pyams_form.widget.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_gis.doctree Binary file src/build/doctrees/pyams_gis.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_gis.rpc.json.doctree Binary file src/build/doctrees/pyams_gis.rpc.json.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_gis.tests.doctree Binary file src/build/doctrees/pyams_gis.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_gis.widget.doctree Binary file src/build/doctrees/pyams_gis.widget.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_i18n.interfaces.doctree Binary file src/build/doctrees/pyams_i18n.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_i18n.widget.doctree Binary file src/build/doctrees/pyams_i18n.widget.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_i18n.zmi.doctree Binary file src/build/doctrees/pyams_i18n.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_ldap.doctree Binary file src/build/doctrees/pyams_ldap.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_ldap.tests.doctree Binary file src/build/doctrees/pyams_ldap.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_mail.doctree Binary file src/build/doctrees/pyams_mail.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_mail.interfaces.doctree Binary file src/build/doctrees/pyams_mail.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_mail.tests.doctree Binary file src/build/doctrees/pyams_mail.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_media.doctree Binary file src/build/doctrees/pyams_media.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_media.skin.doctree Binary file src/build/doctrees/pyams_media.skin.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_media.zmi.doctree Binary file src/build/doctrees/pyams_media.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_notify.doctree Binary file src/build/doctrees/pyams_notify.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_notify.viewlet.doctree Binary file src/build/doctrees/pyams_notify.viewlet.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_pagelet.doctree Binary file src/build/doctrees/pyams_pagelet.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_portal.doctree Binary file src/build/doctrees/pyams_portal.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_portal.portlets.content.doctree Binary file src/build/doctrees/pyams_portal.portlets.content.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_portal.tests.doctree Binary file src/build/doctrees/pyams_portal.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_portal.zmi.doctree Binary file src/build/doctrees/pyams_portal.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_security.tests.doctree Binary file src/build/doctrees/pyams_security.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_security.zmi.plugin.doctree Binary file src/build/doctrees/pyams_security.zmi.plugin.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_security.zmi.widget.doctree Binary file src/build/doctrees/pyams_security.zmi.widget.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_sequence.interfaces.doctree Binary file src/build/doctrees/pyams_sequence.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_sequence.rpc.doctree Binary file src/build/doctrees/pyams_sequence.rpc.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_sequence.widget.doctree Binary file src/build/doctrees/pyams_sequence.widget.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_sequence.zmi.doctree Binary file src/build/doctrees/pyams_sequence.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_skin.doctree Binary file src/build/doctrees/pyams_skin.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_skin.tests.doctree Binary file src/build/doctrees/pyams_skin.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_skin.viewlet.doctree Binary file src/build/doctrees/pyams_skin.viewlet.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_skin.viewlet.flags.doctree Binary file src/build/doctrees/pyams_skin.viewlet.flags.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_skin.viewlet.search.doctree Binary file src/build/doctrees/pyams_skin.viewlet.search.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_skin.viewlet.shortcuts.doctree Binary file src/build/doctrees/pyams_skin.viewlet.shortcuts.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_template.tests.doctree Binary file src/build/doctrees/pyams_template.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_thesaurus.interfaces.doctree Binary file src/build/doctrees/pyams_thesaurus.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_thesaurus.loader.doctree Binary file src/build/doctrees/pyams_thesaurus.loader.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_thesaurus.rpc.json.doctree Binary file src/build/doctrees/pyams_thesaurus.rpc.json.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_thesaurus.widget.doctree Binary file src/build/doctrees/pyams_thesaurus.widget.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_thesaurus.zmi.doctree Binary file src/build/doctrees/pyams_thesaurus.zmi.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_utils.protocol.doctree Binary file src/build/doctrees/pyams_utils.protocol.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_utils.scripts.doctree Binary file src/build/doctrees/pyams_utils.scripts.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_utils.tests.doctree Binary file src/build/doctrees/pyams_utils.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_utils.widget.doctree Binary file src/build/doctrees/pyams_utils.widget.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_viewlet.doctree Binary file src/build/doctrees/pyams_viewlet.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_viewlet.interfaces.doctree Binary file src/build/doctrees/pyams_viewlet.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_viewlet.tests.doctree Binary file src/build/doctrees/pyams_viewlet.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_workflow.doctree Binary file src/build/doctrees/pyams_workflow.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_workflow.tests.doctree Binary file src/build/doctrees/pyams_workflow.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_zmi.interfaces.doctree Binary file src/build/doctrees/pyams_zmi.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_zmi.viewlet.doctree Binary file src/build/doctrees/pyams_zmi.viewlet.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_zmi.viewlet.menu.doctree Binary file src/build/doctrees/pyams_zmi.viewlet.menu.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_zmq.doctree Binary file src/build/doctrees/pyams_zmq.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_zmq.interfaces.doctree Binary file src/build/doctrees/pyams_zmq.interfaces.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_zmq.tests.doctree Binary file src/build/doctrees/pyams_zmq.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_zodbbrowser.doctree Binary file src/build/doctrees/pyams_zodbbrowser.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/pyams_zodbbrowser.tests.doctree Binary file src/build/doctrees/pyams_zodbbrowser.tests.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/site.doctree Binary file src/build/doctrees/site.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/tales.doctree Binary file src/build/doctrees/tales.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/zca.doctree Binary file src/build/doctrees/zca.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/zeo.doctree Binary file src/build/doctrees/zeo.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/doctrees/zodb.doctree Binary file src/build/doctrees/zodb.doctree has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_alchemy.rst.txt --- a/src/build/html/_sources/pyams_alchemy.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,91 +0,0 @@ -.. _pyams_alchemy: - -PyAMS SQLAlchemy integration -============================ - -*pyams_alchemy* package is a small package which can be used to make SQLAlchemy integration more simple. - -The main goal of *pyams_alchemy* package is to define the :class:`pyams_alchemy.engine.AlchemyEngineUtility` class: -this class can be stored persistently into PyAMS local site manager (see :ref:`site`) to store settings of an -SQLAlchemy engine; on user request, the :func:`pyams_alchemy.engine.get_user_session` function can be used to get -access to a new SQLAlchemy engine session matching these settings which will to be bound to current Pyramid's -transaction. - - -Dynamic schema names -++++++++++++++++++++ - -Some times you may have to be able to setup, for a given table, a schema name which is not static but can be dynamic -through a configuration option. - -This can be done easily with the help of the :class:`pyams_alchemy.mixin.DynamicSchemaMixin` which you can inherit from -in any SQLAlchemy table subclass. - -When this is done, the schema name can be defined into Pyramid's configuration file into a setting which is called -*pyams_alchemy:{module_name}.{class_name}.schema*; for example like in -*pyams_alchemy:pyams_content.package.TableName.schema*. If not specified, the table's schema name can be defined in a -classic *__schema__* table's attribute. - - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_alchemy - :members: - :undoc-members: - :show-inheritance: - - -Submodules -++++++++++ - -pyams\_alchemy\.engine module ------------------------------ - -.. automodule:: pyams_alchemy.engine - :members: - :undoc-members: - :show-inheritance: - -pyams\_alchemy\.loader module ------------------------------ - -.. automodule:: pyams_alchemy.loader - :members: - :undoc-members: - :show-inheritance: - -pyams\_alchemy\.metaconfigure module ------------------------------------- - -.. automodule:: pyams_alchemy.metaconfigure - :members: - :undoc-members: - :show-inheritance: - -pyams\_alchemy\.metadirectives module -------------------------------------- - -.. automodule:: pyams_alchemy.metadirectives - :members: - :undoc-members: - :show-inheritance: - -pyams\_alchemy\.mixin module ----------------------------- - -.. automodule:: pyams_alchemy.mixin - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_alchemy.interfaces - pyams_alchemy.tests - pyams_alchemy.zmi diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_alchemy.tests.rst.txt --- a/src/build/html/_sources/pyams_alchemy.tests.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_alchemy\.tests package -============================= - -Submodules -++++++++++ - -pyams\_alchemy\.tests\.test\_utilsdocs module ---------------------------------------------- - -.. automodule:: pyams_alchemy.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_alchemy\.tests\.test\_utilsdocstrings module ---------------------------------------------------- - -.. automodule:: pyams_alchemy.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_alchemy.tests - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_cache.handler.rst.txt --- a/src/build/html/_sources/pyams_cache.handler.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,31 +0,0 @@ -pyams\_cache\.handler package -============================= - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_cache.handler - :members: - :undoc-members: - :show-inheritance: - - -Submodules -++++++++++ - -pyams\_cache\.handler\.memcached module ---------------------------------------- - -.. automodule:: pyams_cache.handler.memcached - :members: - :undoc-members: - :show-inheritance: - -pyams\_cache\.handler\.redis module ------------------------------------ - -.. automodule:: pyams_cache.handler.redis - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.component.association.interfaces.rst.txt --- a/src/build/html/_sources/pyams_content.component.association.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.component\.association\.interfaces package -========================================================== - -Module contents ---------------- - -.. automodule:: pyams_content.component.association.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.component.association.zmi.rst.txt --- a/src/build/html/_sources/pyams_content.component.association.zmi.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_content\.component\.association\.zmi package -=================================================== - -Submodules ----------- - -pyams\_content\.component\.association\.zmi\.interfaces module --------------------------------------------------------------- - -.. automodule:: pyams_content.component.association.zmi.interfaces - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.component\.association\.zmi\.paragraph module -------------------------------------------------------------- - -.. automodule:: pyams_content.component.association.zmi.paragraph - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.component.association.zmi - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.component.extfile.interfaces.rst.txt --- a/src/build/html/_sources/pyams_content.component.extfile.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.component\.extfile\.interfaces package -====================================================== - -Module contents ---------------- - -.. automodule:: pyams_content.component.extfile.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.component.illustration.rst.txt --- a/src/build/html/_sources/pyams_content.component.illustration.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_content\.component\.illustration package -=============================================== - -Subpackages ------------ - -.. toctree:: - - pyams_content.component.illustration.interfaces - pyams_content.component.illustration.zmi - -Submodules ----------- - -pyams\_content\.component\.illustration\.paragraph module ---------------------------------------------------------- - -.. automodule:: pyams_content.component.illustration.paragraph - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.component.illustration - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.component.links.zmi.rst.txt --- a/src/build/html/_sources/pyams_content.component.links.zmi.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_content\.component\.links\.zmi package -============================================= - -Submodules ----------- - -pyams\_content\.component\.links\.zmi\.container module -------------------------------------------------------- - -.. automodule:: pyams_content.component.links.zmi.container - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.component\.links\.zmi\.reverse module ------------------------------------------------------ - -.. automodule:: pyams_content.component.links.zmi.reverse - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.component.links.zmi - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.component.media.rst.txt --- a/src/build/html/_sources/pyams_content.component.media.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.component\.media package -======================================== - -Module contents ---------------- - -.. automodule:: pyams_content.component.media - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.component.theme.interfaces.rst.txt --- a/src/build/html/_sources/pyams_content.component.theme.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.component\.theme\.interfaces package -==================================================== - -Module contents ---------------- - -.. automodule:: pyams_content.component.theme.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.component.theme.zmi.rst.txt --- a/src/build/html/_sources/pyams_content.component.theme.zmi.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_content\.component\.theme\.zmi package -============================================= - -Submodules ----------- - -pyams\_content\.component\.theme\.zmi\.manager module ------------------------------------------------------ - -.. automodule:: pyams_content.component.theme.zmi.manager - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.component\.theme\.zmi\.portlet module ------------------------------------------------------ - -.. automodule:: pyams_content.component.theme.zmi.portlet - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.component.theme.zmi - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.features.checker.rst.txt --- a/src/build/html/_sources/pyams_content.features.checker.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,29 +0,0 @@ -pyams\_content\.features\.checker package -========================================= - -Subpackages ------------ - -.. toctree:: - - pyams_content.features.checker.zmi - -Submodules ----------- - -pyams\_content\.features\.checker\.interfaces module ----------------------------------------------------- - -.. automodule:: pyams_content.features.checker.interfaces - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.features.checker - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.features.rst.txt --- a/src/build/html/_sources/pyams_content.features.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,19 +0,0 @@ -pyams\_content\.features package -================================ - -Subpackages ------------ - -.. toctree:: - - pyams_content.features.checker - pyams_content.features.preview - pyams_content.features.review - -Module contents ---------------- - -.. automodule:: pyams_content.features - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.generations.rst.txt --- a/src/build/html/_sources/pyams_content.generations.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.generations package -=================================== - -Module contents ---------------- - -.. automodule:: pyams_content.generations - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.interfaces.rst.txt --- a/src/build/html/_sources/pyams_content.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_content\.interfaces package -================================== - -Submodules ----------- - -pyams\_content\.interfaces\.container module --------------------------------------------- - -.. automodule:: pyams_content.interfaces.container - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.profile.zmi.rst.txt --- a/src/build/html/_sources/pyams_content.profile.zmi.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.profile\.zmi package -==================================== - -Module contents ---------------- - -.. automodule:: pyams_content.profile.zmi - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.rst.txt --- a/src/build/html/_sources/pyams_content.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,48 +0,0 @@ -pyams\_content package -====================== - -Subpackages ------------ - -.. toctree:: - - pyams_content.component - pyams_content.features - pyams_content.generations - pyams_content.interfaces - pyams_content.profile - pyams_content.root - pyams_content.scripts - pyams_content.shared - pyams_content.skin - pyams_content.tests - pyams_content.workflow - pyams_content.zmi - -Submodules ----------- - -pyams\_content\.include module ------------------------------- - -.. automodule:: pyams_content.include - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.site module ---------------------------- - -.. automodule:: pyams_content.site - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.scripts.rst.txt --- a/src/build/html/_sources/pyams_content.scripts.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_content\.scripts package -=============================== - -Submodules ----------- - -pyams\_content\.scripts\.index module -------------------------------------- - -.. automodule:: pyams_content.scripts.index - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.scripts - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.blog.interfaces.rst.txt --- a/src/build/html/_sources/pyams_content.shared.blog.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.shared\.blog\.interfaces package -================================================ - -Module contents ---------------- - -.. automodule:: pyams_content.shared.blog.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.common.interfaces.rst.txt --- a/src/build/html/_sources/pyams_content.shared.common.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_content\.shared\.common\.interfaces package -================================================== - -Submodules ----------- - -pyams\_content\.shared\.common\.interfaces\.types module --------------------------------------------------------- - -.. automodule:: pyams_content.shared.common.interfaces.types - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.common\.interfaces\.zmi module ------------------------------------------------------- - -.. automodule:: pyams_content.shared.common.interfaces.zmi - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.shared.common.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.common.rst.txt --- a/src/build/html/_sources/pyams_content.shared.common.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,54 +0,0 @@ -pyams\_content\.shared\.common package -====================================== - -Subpackages ------------ - -.. toctree:: - - pyams_content.shared.common.interfaces - pyams_content.shared.common.zmi - -Submodules ----------- - -pyams\_content\.shared\.common\.manager module ----------------------------------------------- - -.. automodule:: pyams_content.shared.common.manager - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.common\.review module ---------------------------------------------- - -.. automodule:: pyams_content.shared.common.review - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.common\.security module ------------------------------------------------ - -.. automodule:: pyams_content.shared.common.security - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.common\.types module --------------------------------------------- - -.. automodule:: pyams_content.shared.common.types - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.shared.common - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.form.interfaces.rst.txt --- a/src/build/html/_sources/pyams_content.shared.form.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.shared\.form\.interfaces package -================================================ - -Module contents ---------------- - -.. automodule:: pyams_content.shared.form.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.form.rst.txt --- a/src/build/html/_sources/pyams_content.shared.form.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,46 +0,0 @@ -pyams\_content\.shared\.form package -==================================== - -Subpackages ------------ - -.. toctree:: - - pyams_content.shared.form.interfaces - pyams_content.shared.form.zmi - -Submodules ----------- - -pyams\_content\.shared\.form\.field module ------------------------------------------- - -.. automodule:: pyams_content.shared.form.field - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.form\.handler module --------------------------------------------- - -.. automodule:: pyams_content.shared.form.handler - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.form\.manager module --------------------------------------------- - -.. automodule:: pyams_content.shared.form.manager - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.shared.form - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.imagemap.rst.txt --- a/src/build/html/_sources/pyams_content.shared.imagemap.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,46 +0,0 @@ -pyams\_content\.shared\.imagemap package -======================================== - -Subpackages ------------ - -.. toctree:: - - pyams_content.shared.imagemap.interfaces - pyams_content.shared.imagemap.zmi - -Submodules ----------- - -pyams\_content\.shared\.imagemap\.manager module ------------------------------------------------- - -.. automodule:: pyams_content.shared.imagemap.manager - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.imagemap\.paragraph module --------------------------------------------------- - -.. automodule:: pyams_content.shared.imagemap.paragraph - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.imagemap\.schema module ------------------------------------------------ - -.. automodule:: pyams_content.shared.imagemap.schema - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.shared.imagemap - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.news.zmi.rst.txt --- a/src/build/html/_sources/pyams_content.shared.news.zmi.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.shared\.news\.zmi package -========================================= - -Module contents ---------------- - -.. automodule:: pyams_content.shared.news.zmi - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.site.interfaces.rst.txt --- a/src/build/html/_sources/pyams_content.shared.site.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.shared\.site\.interfaces package -================================================ - -Module contents ---------------- - -.. automodule:: pyams_content.shared.site.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.site.rst.txt --- a/src/build/html/_sources/pyams_content.shared.site.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,54 +0,0 @@ -pyams\_content\.shared\.site package -==================================== - -Subpackages ------------ - -.. toctree:: - - pyams_content.shared.site.interfaces - pyams_content.shared.site.zmi - -Submodules ----------- - -pyams\_content\.shared\.site\.container module ----------------------------------------------- - -.. automodule:: pyams_content.shared.site.container - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.site\.folder module -------------------------------------------- - -.. automodule:: pyams_content.shared.site.folder - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.site\.link module ------------------------------------------ - -.. automodule:: pyams_content.shared.site.link - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.site\.manager module --------------------------------------------- - -.. automodule:: pyams_content.shared.site.manager - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.shared.site - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.site.zmi.rst.txt --- a/src/build/html/_sources/pyams_content.shared.site.zmi.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,53 +0,0 @@ -pyams\_content\.shared\.site\.zmi package -========================================= - -Subpackages ------------ - -.. toctree:: - - pyams_content.shared.site.zmi.widget - -Submodules ----------- - -pyams\_content\.shared\.site\.zmi\.container module ---------------------------------------------------- - -.. automodule:: pyams_content.shared.site.zmi.container - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.site\.zmi\.folder module ------------------------------------------------- - -.. automodule:: pyams_content.shared.site.zmi.folder - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.site\.zmi\.link module ----------------------------------------------- - -.. automodule:: pyams_content.shared.site.zmi.link - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.site\.zmi\.manager module -------------------------------------------------- - -.. automodule:: pyams_content.shared.site.zmi.manager - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.shared.site.zmi - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.site.zmi.widget.rst.txt --- a/src/build/html/_sources/pyams_content.shared.site.zmi.widget.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_content\.shared\.site\.zmi\.widget package -================================================= - -Submodules ----------- - -pyams\_content\.shared\.site\.zmi\.widget\.interfaces module ------------------------------------------------------------- - -.. automodule:: pyams_content.shared.site.zmi.widget.interfaces - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.shared.site.zmi.widget - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.view.interfaces.rst.txt --- a/src/build/html/_sources/pyams_content.shared.view.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\.shared\.view\.interfaces package -================================================ - -Module contents ---------------- - -.. automodule:: pyams_content.shared.view.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.shared.view.zmi.rst.txt --- a/src/build/html/_sources/pyams_content.shared.view.zmi.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,46 +0,0 @@ -pyams\_content\.shared\.view\.zmi package -========================================= - -Submodules ----------- - -pyams\_content\.shared\.view\.zmi\.preview module -------------------------------------------------- - -.. automodule:: pyams_content.shared.view.zmi.preview - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.view\.zmi\.properties module ----------------------------------------------------- - -.. automodule:: pyams_content.shared.view.zmi.properties - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.view\.zmi\.reference module ---------------------------------------------------- - -.. automodule:: pyams_content.shared.view.zmi.reference - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.shared\.view\.zmi\.theme module ------------------------------------------------ - -.. automodule:: pyams_content.shared.view.zmi.theme - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.shared.view.zmi - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.tests.rst.txt --- a/src/build/html/_sources/pyams_content.tests.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_content\.tests package -============================= - -Submodules ----------- - -pyams\_content\.tests\.test\_utilsdocs module ---------------------------------------------- - -.. automodule:: pyams_content.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\.tests\.test\_utilsdocstrings module ---------------------------------------------------- - -.. automodule:: pyams_content.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content.tests - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content.zmi.viewlet.rst.txt --- a/src/build/html/_sources/pyams_content.zmi.viewlet.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -pyams\_content\.zmi\.viewlet package -==================================== - -Subpackages ------------ - -.. toctree:: - - pyams_content.zmi.viewlet.toplinks - -Module contents ---------------- - -.. automodule:: pyams_content.zmi.viewlet - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content_es.interfaces.rst.txt --- a/src/build/html/_sources/pyams_content_es.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\_es\.interfaces package -====================================== - -Module contents ---------------- - -.. automodule:: pyams_content_es.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_content_es.scripts.rst.txt --- a/src/build/html/_sources/pyams_content_es.scripts.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_content\_es\.scripts package -=================================== - -Submodules ----------- - -pyams\_content\_es\.scripts\.index module ------------------------------------------ - -.. automodule:: pyams_content_es.scripts.index - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content_es.scripts - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_gis.rpc.json.rst.txt --- a/src/build/html/_sources/pyams_gis.rpc.json.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_gis\.rpc\.json package -============================= - -Module contents ---------------- - -.. automodule:: pyams_gis.rpc.json - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_gis.rpc.rst.txt --- a/src/build/html/_sources/pyams_gis.rpc.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -pyams\_gis\.rpc package -======================= - -Subpackages ------------ - -.. toctree:: - - pyams_gis.rpc.json - -Module contents ---------------- - -.. automodule:: pyams_gis.rpc - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_gis.rst.txt --- a/src/build/html/_sources/pyams_gis.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,89 +0,0 @@ -pyams\_gis package -================== - -Subpackages ------------ - -.. toctree:: - - pyams_gis.interfaces - pyams_gis.rpc - pyams_gis.tests - pyams_gis.widget - pyams_gis.zmi - -Submodules ----------- - -pyams\_gis\.area module ------------------------ - -.. automodule:: pyams_gis.area - :members: - :undoc-members: - :show-inheritance: - -pyams\_gis\.configuration module --------------------------------- - -.. automodule:: pyams_gis.configuration - :members: - :undoc-members: - :show-inheritance: - -pyams\_gis\.include module --------------------------- - -.. automodule:: pyams_gis.include - :members: - :undoc-members: - :show-inheritance: - -pyams\_gis\.layer module ------------------------- - -.. automodule:: pyams_gis.layer - :members: - :undoc-members: - :show-inheritance: - -pyams\_gis\.point module ------------------------- - -.. automodule:: pyams_gis.point - :members: - :undoc-members: - :show-inheritance: - -pyams\_gis\.schema module -------------------------- - -.. automodule:: pyams_gis.schema - :members: - :undoc-members: - :show-inheritance: - -pyams\_gis\.site module ------------------------ - -.. automodule:: pyams_gis.site - :members: - :undoc-members: - :show-inheritance: - -pyams\_gis\.utility module --------------------------- - -.. automodule:: pyams_gis.utility - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_gis - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_gis.tests.rst.txt --- a/src/build/html/_sources/pyams_gis.tests.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_gis\.tests package -========================= - -Submodules ----------- - -pyams\_gis\.tests\.test\_utilsdocs module ------------------------------------------ - -.. automodule:: pyams_gis.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_gis\.tests\.test\_utilsdocstrings module ------------------------------------------------ - -.. automodule:: pyams_gis.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_gis.tests - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_i18n.rst.txt --- a/src/build/html/_sources/pyams_i18n.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,123 +0,0 @@ -.. _pyams_i18n: - -PyAMS internationalization -========================== - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_i18n - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_i18n.interfaces - pyams_i18n.widget - pyams_i18n.zmi - - -Submodules -++++++++++ - -pyams\_i18n\.attr module ------------------------- - -.. automodule:: pyams_i18n.attr - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.column module --------------------------- - -.. automodule:: pyams_i18n.column - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.content module ---------------------------- - -.. automodule:: pyams_i18n.content - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.expr module ------------------------- - -.. automodule:: pyams_i18n.expr - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.include module ---------------------------- - -.. automodule:: pyams_i18n.include - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.index module -------------------------- - -.. automodule:: pyams_i18n.index - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.language module ----------------------------- - -.. automodule:: pyams_i18n.language - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.negotiator module ------------------------------- - -.. automodule:: pyams_i18n.negotiator - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.property module ----------------------------- - -.. automodule:: pyams_i18n.property - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.schema module --------------------------- - -.. automodule:: pyams_i18n.schema - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.site module ------------------------- - -.. automodule:: pyams_i18n.site - :members: - :undoc-members: - :show-inheritance: - -pyams\_i18n\.vocabulary module ------------------------------- - -.. automodule:: pyams_i18n.vocabulary - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_ldap.interfaces.rst.txt --- a/src/build/html/_sources/pyams_ldap.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_ldap\.interfaces package -=============================== - -Module contents ---------------- - -.. automodule:: pyams_ldap.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_mail.tests.rst.txt --- a/src/build/html/_sources/pyams_mail.tests.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_mail\.tests package -========================== - -Submodules ----------- - -pyams\_mail\.tests\.test\_utilsdocs module ------------------------------------------- - -.. automodule:: pyams_mail.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_mail\.tests\.test\_utilsdocstrings module ------------------------------------------------- - -.. automodule:: pyams_mail.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_mail.tests - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_notify.handlers.rst.txt --- a/src/build/html/_sources/pyams_notify.handlers.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_notify\.handlers package -=============================== - -Submodules ----------- - -pyams\_notify\.handlers\.login module -------------------------------------- - -.. automodule:: pyams_notify.handlers.login - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_notify.handlers - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_notify.interfaces.rst.txt --- a/src/build/html/_sources/pyams_notify.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_notify\.interfaces package -================================= - -Module contents ---------------- - -.. automodule:: pyams_notify.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_notify.rst.txt --- a/src/build/html/_sources/pyams_notify.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -.. _pyams_notify: - -PyAMS notification services -=========================== - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_notify - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_notify.handlers - pyams_notify.interfaces - pyams_notify.skin - pyams_notify.tests - pyams_notify.viewlet - pyams_notify.views - - -Submodules -++++++++++ diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_notify.skin.rst.txt --- a/src/build/html/_sources/pyams_notify.skin.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_notify\.skin package -=========================== - -Module contents ---------------- - -.. automodule:: pyams_notify.skin - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_notify.viewlet.rst.txt --- a/src/build/html/_sources/pyams_notify.viewlet.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_notify\.viewlet package -============================== - -Module contents ---------------- - -.. automodule:: pyams_notify.viewlet - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_pagelet.interfaces.rst.txt --- a/src/build/html/_sources/pyams_pagelet.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_pagelet\.interfaces package -================================== - -Module contents ---------------- - -.. automodule:: pyams_pagelet.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_pagelet.rst.txt --- a/src/build/html/_sources/pyams_pagelet.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,50 +0,0 @@ -.. _pyams_pagelet: - -PyAMS pagelets -============== - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_pagelet - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_pagelet.interfaces - pyams_pagelet.tests - - -Submodules -++++++++++ - -pyams\_pagelet\.metaconfigure module ------------------------------------- - -.. automodule:: pyams_pagelet.metaconfigure - :members: - :undoc-members: - :show-inheritance: - -pyams\_pagelet\.metadirectives module -------------------------------------- - -.. automodule:: pyams_pagelet.metadirectives - :members: - :undoc-members: - :show-inheritance: - -pyams\_pagelet\.pagelet module ------------------------------- - -.. automodule:: pyams_pagelet.pagelet - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_portal.portlets.content.rst.txt --- a/src/build/html/_sources/pyams_portal.portlets.content.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_portal\.portlets\.content package -======================================== - -Submodules ----------- - -pyams\_portal\.portlets\.content\.interfaces module ---------------------------------------------------- - -.. automodule:: pyams_portal.portlets.content.interfaces - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_portal.portlets.content - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_portal.portlets.image.rst.txt --- a/src/build/html/_sources/pyams_portal.portlets.image.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_portal\.portlets\.image package -====================================== - -Submodules ----------- - -pyams\_portal\.portlets\.image\.interfaces module -------------------------------------------------- - -.. automodule:: pyams_portal.portlets.image.interfaces - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_portal.portlets.image - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_portal.portlets.rst.txt --- a/src/build/html/_sources/pyams_portal.portlets.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -pyams\_portal\.portlets package -=============================== - -Subpackages ------------ - -.. toctree:: - - pyams_portal.portlets.content - pyams_portal.portlets.image - -Module contents ---------------- - -.. automodule:: pyams_portal.portlets - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_portal.rst.txt --- a/src/build/html/_sources/pyams_portal.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,80 +0,0 @@ -pyams\_portal package -===================== - -Subpackages ------------ - -.. toctree:: - - pyams_portal.interfaces - pyams_portal.portlets - pyams_portal.tests - pyams_portal.zmi - -Submodules ----------- - -pyams\_portal\.include module ------------------------------ - -.. automodule:: pyams_portal.include - :members: - :undoc-members: - :show-inheritance: - -pyams\_portal\.page module --------------------------- - -.. automodule:: pyams_portal.page - :members: - :undoc-members: - :show-inheritance: - -pyams\_portal\.portlet module ------------------------------ - -.. automodule:: pyams_portal.portlet - :members: - :undoc-members: - :show-inheritance: - -pyams\_portal\.site module --------------------------- - -.. automodule:: pyams_portal.site - :members: - :undoc-members: - :show-inheritance: - -pyams\_portal\.slot module --------------------------- - -.. automodule:: pyams_portal.slot - :members: - :undoc-members: - :show-inheritance: - -pyams\_portal\.template module ------------------------------- - -.. automodule:: pyams_portal.template - :members: - :undoc-members: - :show-inheritance: - -pyams\_portal\.views module ---------------------------- - -.. automodule:: pyams_portal.views - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_portal - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_portal.tests.rst.txt --- a/src/build/html/_sources/pyams_portal.tests.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_portal\.tests package -============================ - -Submodules ----------- - -pyams\_portal\.tests\.test\_utilsdocs module --------------------------------------------- - -.. automodule:: pyams_portal.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_portal\.tests\.test\_utilsdocstrings module --------------------------------------------------- - -.. automodule:: pyams_portal.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_portal.tests - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_scheduler.interfaces.rst.txt --- a/src/build/html/_sources/pyams_scheduler.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,38 +0,0 @@ -pyams\_scheduler\.interfaces package -==================================== - -Submodules ----------- - -pyams\_scheduler\.interfaces\.ssh module ----------------------------------------- - -.. automodule:: pyams_scheduler.interfaces.ssh - :members: - :undoc-members: - :show-inheritance: - -pyams\_scheduler\.interfaces\.url module ----------------------------------------- - -.. automodule:: pyams_scheduler.interfaces.url - :members: - :undoc-members: - :show-inheritance: - -pyams\_scheduler\.interfaces\.zodb module ------------------------------------------ - -.. automodule:: pyams_scheduler.interfaces.zodb - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_scheduler.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_security.interfaces.rst.txt --- a/src/build/html/_sources/pyams_security.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_security\.interfaces package -=================================== - -Submodules ----------- - -pyams\_security\.interfaces\.notification module ------------------------------------------------- - -.. automodule:: pyams_security.interfaces.notification - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.interfaces\.profile module -------------------------------------------- - -.. automodule:: pyams_security.interfaces.profile - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_security.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_security.plugin.rst.txt --- a/src/build/html/_sources/pyams_security.plugin.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,54 +0,0 @@ -pyams\_security\.plugin package -=============================== - -Submodules ----------- - -pyams\_security\.plugin\.admin module -------------------------------------- - -.. automodule:: pyams_security.plugin.admin - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.plugin\.group module -------------------------------------- - -.. automodule:: pyams_security.plugin.group - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.plugin\.http module ------------------------------------- - -.. automodule:: pyams_security.plugin.http - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.plugin\.social module --------------------------------------- - -.. automodule:: pyams_security.plugin.social - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.plugin\.userfolder module ------------------------------------------- - -.. automodule:: pyams_security.plugin.userfolder - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_security.plugin - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_security.rst.txt --- a/src/build/html/_sources/pyams_security.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,142 +0,0 @@ -.. _pyams_security: - -PyAMS security -============== - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_security - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_security.interfaces - pyams_security.plugin - pyams_security.tests - pyams_security.views - pyams_security.widget - pyams_security.zmi - - -Submodules -++++++++++ - -pyams\_security\.credential module ----------------------------------- - -.. automodule:: pyams_security.credential - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.include module -------------------------------- - -.. automodule:: pyams_security.include - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.index module ------------------------------ - -.. automodule:: pyams_security.index - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.notification module ------------------------------------- - -.. automodule:: pyams_security.notification - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.permission module ----------------------------------- - -.. automodule:: pyams_security.permission - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.principal module ---------------------------------- - -.. automodule:: pyams_security.principal - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.profile module -------------------------------- - -.. automodule:: pyams_security.profile - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.property module --------------------------------- - -.. automodule:: pyams_security.property - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.role module ----------------------------- - -.. automodule:: pyams_security.role - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.schema module ------------------------------- - -.. automodule:: pyams_security.schema - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.security module --------------------------------- - -.. automodule:: pyams_security.security - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.site module ----------------------------- - -.. automodule:: pyams_security.site - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.utility module -------------------------------- - -.. automodule:: pyams_security.utility - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.vocabulary module ----------------------------------- - -.. automodule:: pyams_security.vocabulary - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_security.views.rst.txt --- a/src/build/html/_sources/pyams_security.views.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,46 +0,0 @@ -pyams\_security\.views package -============================== - -Submodules ----------- - -pyams\_security\.views\.login module ------------------------------------- - -.. automodule:: pyams_security.views.login - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.views\.oauth module ------------------------------------- - -.. automodule:: pyams_security.views.oauth - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.views\.userfolder module ------------------------------------------ - -.. automodule:: pyams_security.views.userfolder - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.views\.utility module --------------------------------------- - -.. automodule:: pyams_security.views.utility - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_security.views - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_security.widget.rst.txt --- a/src/build/html/_sources/pyams_security.widget.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_security\.widget package -=============================== - -Submodules ----------- - -pyams\_security\.widget\.interfaces module ------------------------------------------- - -.. automodule:: pyams_security.widget.interfaces - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_security.widget - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_security.zmi.plugin.rst.txt --- a/src/build/html/_sources/pyams_security.zmi.plugin.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,46 +0,0 @@ -pyams\_security\.zmi\.plugin package -==================================== - -Submodules ----------- - -pyams\_security\.zmi\.plugin\.admin module ------------------------------------------- - -.. automodule:: pyams_security.zmi.plugin.admin - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.zmi\.plugin\.group module ------------------------------------------- - -.. automodule:: pyams_security.zmi.plugin.group - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.zmi\.plugin\.social module -------------------------------------------- - -.. automodule:: pyams_security.zmi.plugin.social - :members: - :undoc-members: - :show-inheritance: - -pyams\_security\.zmi\.plugin\.userfolder module ------------------------------------------------ - -.. automodule:: pyams_security.zmi.plugin.userfolder - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_security.zmi.plugin - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_security.zmi.widget.rst.txt --- a/src/build/html/_sources/pyams_security.zmi.widget.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_security\.zmi\.widget package -==================================== - -Module contents ---------------- - -.. automodule:: pyams_security.zmi.widget - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_sequence.interfaces.rst.txt --- a/src/build/html/_sources/pyams_sequence.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_sequence\.interfaces package -=================================== - -Module contents ---------------- - -.. automodule:: pyams_sequence.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_sequence.rpc.json.rst.txt --- a/src/build/html/_sources/pyams_sequence.rpc.json.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_sequence\.rpc\.json package -================================== - -Module contents ---------------- - -.. automodule:: pyams_sequence.rpc.json - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_sequence.rpc.rst.txt --- a/src/build/html/_sources/pyams_sequence.rpc.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -pyams\_sequence\.rpc package -============================ - -Subpackages ------------ - -.. toctree:: - - pyams_sequence.rpc.json - -Module contents ---------------- - -.. automodule:: pyams_sequence.rpc - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_sequence.zmi.rst.txt --- a/src/build/html/_sources/pyams_sequence.zmi.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_sequence\.zmi package -============================ - -Module contents ---------------- - -.. automodule:: pyams_sequence.zmi - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_skin.interfaces.rst.txt --- a/src/build/html/_sources/pyams_skin.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,70 +0,0 @@ -pyams\_skin\.interfaces package -=============================== - -Submodules ----------- - -pyams\_skin\.interfaces\.configuration module ---------------------------------------------- - -.. automodule:: pyams_skin.interfaces.configuration - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.interfaces\.container module ------------------------------------------ - -.. automodule:: pyams_skin.interfaces.container - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.interfaces\.extension module ------------------------------------------ - -.. automodule:: pyams_skin.interfaces.extension - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.interfaces\.metas module -------------------------------------- - -.. automodule:: pyams_skin.interfaces.metas - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.interfaces\.resources module ------------------------------------------ - -.. automodule:: pyams_skin.interfaces.resources - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.interfaces\.tinymce module ---------------------------------------- - -.. automodule:: pyams_skin.interfaces.tinymce - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.interfaces\.viewlet module ---------------------------------------- - -.. automodule:: pyams_skin.interfaces.viewlet - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_skin.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_skin.rst.txt --- a/src/build/html/_sources/pyams_skin.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,123 +0,0 @@ -.. _pyams_skin: - -PyAMS skin utilities -==================== - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_skin - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_skin.interfaces - pyams_skin.tests - pyams_skin.viewlet - - -Submodules -++++++++++ - -pyams\_skin\.configuration module ---------------------------------- - -.. automodule:: pyams_skin.configuration - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.container module ------------------------------ - -.. automodule:: pyams_skin.container - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.extension module ------------------------------ - -.. automodule:: pyams_skin.extension - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.help module ------------------------- - -.. automodule:: pyams_skin.help - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.layer module -------------------------- - -.. automodule:: pyams_skin.layer - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.metas module -------------------------- - -.. automodule:: pyams_skin.metas - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.page module ------------------------- - -.. automodule:: pyams_skin.page - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.resources module ------------------------------ - -.. automodule:: pyams_skin.resources - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.site module ------------------------- - -.. automodule:: pyams_skin.site - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.skin module ------------------------- - -.. automodule:: pyams_skin.skin - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.table module -------------------------- - -.. automodule:: pyams_skin.table - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.vocabulary module ------------------------------- - -.. automodule:: pyams_skin.vocabulary - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_skin.tests.rst.txt --- a/src/build/html/_sources/pyams_skin.tests.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_skin\.tests package -========================== - -Submodules ----------- - -pyams\_skin\.tests\.test\_utilsdocs module ------------------------------------------- - -.. automodule:: pyams_skin.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.tests\.test\_utilsdocstrings module ------------------------------------------------- - -.. automodule:: pyams_skin.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_skin.tests - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_skin.viewlet.extension.rst.txt --- a/src/build/html/_sources/pyams_skin.viewlet.extension.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,38 +0,0 @@ -pyams\_skin\.viewlet\.extension package -======================================= - -Submodules ----------- - -pyams\_skin\.viewlet\.extension\.analytics module -------------------------------------------------- - -.. automodule:: pyams_skin.viewlet.extension.analytics - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.viewlet\.extension\.tagmanager module --------------------------------------------------- - -.. automodule:: pyams_skin.viewlet.extension.tagmanager - :members: - :undoc-members: - :show-inheritance: - -pyams\_skin\.viewlet\.extension\.user\_report module ----------------------------------------------------- - -.. automodule:: pyams_skin.viewlet.extension.user_report - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_skin.viewlet.extension - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_skin.viewlet.menu.rst.txt --- a/src/build/html/_sources/pyams_skin.viewlet.menu.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_skin\.viewlet\.menu package -================================== - -Module contents ---------------- - -.. automodule:: pyams_skin.viewlet.menu - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_skin.viewlet.search.rst.txt --- a/src/build/html/_sources/pyams_skin.viewlet.search.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_skin\.viewlet\.search package -==================================== - -Module contents ---------------- - -.. automodule:: pyams_skin.viewlet.search - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_skin.viewlet.shortcuts.rst.txt --- a/src/build/html/_sources/pyams_skin.viewlet.shortcuts.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_skin\.viewlet\.shortcuts package -======================================= - -Module contents ---------------- - -.. automodule:: pyams_skin.viewlet.shortcuts - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_template.tests.rst.txt --- a/src/build/html/_sources/pyams_template.tests.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_template\.tests package -============================== - -Submodules ----------- - -pyams\_template\.tests\.test\_utilsdocs module ----------------------------------------------- - -.. automodule:: pyams_template.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_template\.tests\.test\_utilsdocstrings module ----------------------------------------------------- - -.. automodule:: pyams_template.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_template.tests - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_thesaurus.rst.txt --- a/src/build/html/_sources/pyams_thesaurus.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,70 +0,0 @@ -.. _pyams_thesaurus: - -PyAMS thesaurus manager -======================= - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_thesaurus - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_thesaurus.interfaces - pyams_thesaurus.loader - pyams_thesaurus.rpc - pyams_thesaurus.tests - pyams_thesaurus.widget - pyams_thesaurus.zmi - - -Submodules -++++++++++ - -pyams_thesaurus.include module ------------------------------- - -.. automodule:: pyams_thesaurus.include - :members: - :undoc-members: - :show-inheritance: - -pyams_thesaurus.index module ----------------------------- - -.. automodule:: pyams_thesaurus.index - :members: - :undoc-members: - :show-inheritance: - -pyams_thesaurus.schema module ------------------------------ - -.. automodule:: pyams_thesaurus.schema - :members: - :undoc-members: - :show-inheritance: - -pyams_thesaurus.term module ---------------------------- - -.. automodule:: pyams_thesaurus.term - :members: - :undoc-members: - :show-inheritance: - -pyams_thesaurus.thesaurus module --------------------------------- - -.. automodule:: pyams_thesaurus.thesaurus - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_thesaurus.widget.rst.txt --- a/src/build/html/_sources/pyams_thesaurus.widget.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,23 +0,0 @@ -pyams\_thesaurus\.widget package -================================ - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_thesaurus.widget - :members: - :undoc-members: - :show-inheritance: - - -Submodules -++++++++++ - -pyams\_thesaurus\.widget\.interfaces module -------------------------------------------- - -.. automodule:: pyams_thesaurus.widget.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_thesaurus.zmi.rst.txt --- a/src/build/html/_sources/pyams_thesaurus.zmi.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,55 +0,0 @@ -pyams\_thesaurus\.zmi package -============================= - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_thesaurus.zmi - :members: - :undoc-members: - :show-inheritance: - - -Submodules -++++++++++ - -pyams\_thesaurus\.zmi\.extract module -------------------------------------- - -.. automodule:: pyams_thesaurus.zmi.extract - :members: - :undoc-members: - :show-inheritance: - -pyams\_thesaurus\.zmi\.interfaces module ----------------------------------------- - -.. automodule:: pyams_thesaurus.zmi.interfaces - :members: - :undoc-members: - :show-inheritance: - -pyams\_thesaurus\.zmi\.manager module -------------------------------------- - -.. automodule:: pyams_thesaurus.zmi.manager - :members: - :undoc-members: - :show-inheritance: - -pyams\_thesaurus\.zmi\.term module ----------------------------------- - -.. automodule:: pyams_thesaurus.zmi.term - :members: - :undoc-members: - :show-inheritance: - -pyams\_thesaurus\.zmi\.thesaurus module ---------------------------------------- - -.. automodule:: pyams_thesaurus.zmi.thesaurus - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_utils.rst.txt --- a/src/build/html/_sources/pyams_utils.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,286 +0,0 @@ -.. _pyams_utils: - -PyAMS utilities -=============== - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_utils.interfaces - pyams_utils.protocol - pyams_utils.scripts - pyams_utils.tests - pyams_utils.timezone - pyams_utils.widget - pyams_utils.zmi - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_utils - :members: - :undoc-members: - :show-inheritance: - - -Submodules -++++++++++ - -pyams_utils.adapter module --------------------------- - -.. automodule:: pyams_utils.adapter - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.attr module ------------------------ - -.. automodule:: pyams_utils.attr - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.container module ----------------------------- - -.. automodule:: pyams_utils.container - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.context module --------------------------- - -.. automodule:: pyams_utils.context - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.data module ------------------------ - -.. automodule:: pyams_utils.data - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.date module ------------------------ - -.. automodule:: pyams_utils.date - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.decorator module ----------------------------- - -.. automodule:: pyams_utils.decorator - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.dict module ------------------------ - -.. automodule:: pyams_utils.dict - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.encoding module ---------------------------- - -.. automodule:: pyams_utils.encoding - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.fanstatic module ----------------------------- - -.. automodule:: pyams_utils.fanstatic - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.html module ------------------------ - -.. automodule:: pyams_utils.html - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.i18n module ------------------------ - -.. automodule:: pyams_utils.i18n - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.include module --------------------------- - -.. automodule:: pyams_utils.include - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.intids module -------------------------- - -.. automodule:: pyams_utils.intids - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.list module ------------------------ - -.. automodule:: pyams_utils.list - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.lock module ------------------------ - -.. automodule:: pyams_utils.lock - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.progress module ---------------------------- - -.. automodule:: pyams_utils.progress - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.property module ---------------------------- - -.. automodule:: pyams_utils.property - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.registry module ---------------------------- - -.. automodule:: pyams_utils.registry - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.request module --------------------------- - -.. automodule:: pyams_utils.request - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.schema module -------------------------- - -.. automodule:: pyams_utils.schema - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.session module --------------------------- - -.. automodule:: pyams_utils.session - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.site module ------------------------ - -.. automodule:: pyams_utils.site - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.size module ------------------------ - -.. automodule:: pyams_utils.size - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.tales module ------------------------- - -.. automodule:: pyams_utils.tales - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.text module ------------------------ - -.. automodule:: pyams_utils.text - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.traversing module ------------------------------ - -.. automodule:: pyams_utils.traversing - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.unicode module --------------------------- - -.. automodule:: pyams_utils.unicode - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.url module ----------------------- - -.. automodule:: pyams_utils.url - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.vocabulary module ------------------------------ - -.. automodule:: pyams_utils.vocabulary - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.wsgi module ------------------------ - -.. automodule:: pyams_utils.wsgi - :members: - :undoc-members: - :show-inheritance: - -pyams_utils.zodb module ------------------------ - -.. automodule:: pyams_utils.zodb - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_viewlet.rst.txt --- a/src/build/html/_sources/pyams_viewlet.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,66 +0,0 @@ -.. _pyams_viewlet: - -PyAMS viewlets -============== - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_viewlet - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_viewlet.interfaces - pyams_viewlet.tests - - -Submodules -++++++++++ - -pyams\_viewlet\.manager module ------------------------------- - -.. automodule:: pyams_viewlet.manager - :members: - :undoc-members: - :show-inheritance: - -pyams\_viewlet\.metaconfigure module ------------------------------------- - -.. automodule:: pyams_viewlet.metaconfigure - :members: - :undoc-members: - :show-inheritance: - -pyams\_viewlet\.metadirectives module -------------------------------------- - -.. automodule:: pyams_viewlet.metadirectives - :members: - :undoc-members: - :show-inheritance: - -pyams\_viewlet\.provider module -------------------------------- - -.. automodule:: pyams_viewlet.provider - :members: - :undoc-members: - :show-inheritance: - -pyams\_viewlet\.viewlet module ------------------------------- - -.. automodule:: pyams_viewlet.viewlet - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_viewlet.tests.rst.txt --- a/src/build/html/_sources/pyams_viewlet.tests.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_viewlet\.tests package -============================= - -Submodules ----------- - -pyams\_viewlet\.tests\.test\_utilsdocs module ---------------------------------------------- - -.. automodule:: pyams_viewlet.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_viewlet\.tests\.test\_utilsdocstrings module ---------------------------------------------------- - -.. automodule:: pyams_viewlet.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_viewlet.tests - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_workflow.interfaces.rst.txt --- a/src/build/html/_sources/pyams_workflow.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_workflow\.interfaces package -=================================== - -Module contents ---------------- - -.. automodule:: pyams_workflow.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_workflow.rst.txt --- a/src/build/html/_sources/pyams_workflow.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,55 +0,0 @@ -pyams\_workflow package -======================= - -Subpackages ------------ - -.. toctree:: - - pyams_workflow.interfaces - pyams_workflow.tests - pyams_workflow.zmi - -Submodules ----------- - -pyams\_workflow\.content module -------------------------------- - -.. automodule:: pyams_workflow.content - :members: - :undoc-members: - :show-inheritance: - -pyams\_workflow\.include module -------------------------------- - -.. automodule:: pyams_workflow.include - :members: - :undoc-members: - :show-inheritance: - -pyams\_workflow\.versions module --------------------------------- - -.. automodule:: pyams_workflow.versions - :members: - :undoc-members: - :show-inheritance: - -pyams\_workflow\.workflow module --------------------------------- - -.. automodule:: pyams_workflow.workflow - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_workflow - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_workflow.zmi.viewlet.rst.txt --- a/src/build/html/_sources/pyams_workflow.zmi.viewlet.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_workflow\.zmi\.viewlet package -===================================== - -Submodules ----------- - -pyams\_workflow\.zmi\.viewlet\.versions module ----------------------------------------------- - -.. automodule:: pyams_workflow.zmi.viewlet.versions - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_workflow.zmi.viewlet - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_zmi.interfaces.rst.txt --- a/src/build/html/_sources/pyams_zmi.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_zmi\.interfaces package -============================== - -Submodules ----------- - -pyams\_zmi\.interfaces\.menu module ------------------------------------ - -.. automodule:: pyams_zmi.interfaces.menu - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_zmi.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_zmi.viewlet.menu.rst.txt --- a/src/build/html/_sources/pyams_zmi.viewlet.menu.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_zmi\.viewlet\.menu package -================================= - -Module contents ---------------- - -.. automodule:: pyams_zmi.viewlet.menu - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_zmq.interfaces.rst.txt --- a/src/build/html/_sources/pyams_zmq.interfaces.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_zmq\.interfaces package -============================== - -Module contents ---------------- - -.. automodule:: pyams_zmq.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/pyams_zmq.tests.rst.txt --- a/src/build/html/_sources/pyams_zmq.tests.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_zmq\.tests package -========================= - -Submodules ----------- - -pyams\_zmq\.tests\.test\_utilsdocs module ------------------------------------------ - -.. automodule:: pyams_zmq.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_zmq\.tests\.test\_utilsdocstrings module ------------------------------------------------ - -.. automodule:: pyams_zmq.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_zmq.tests - :members: - :undoc-members: - :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/utilities.rst.txt --- a/src/build/html/_sources/utilities.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,57 +0,0 @@ -.. _utilities: - -Custom PyAMS utilities -====================== - -PyAMS_utils provides a small set of utilities. You can create some of them as global utilities registered in -the global components registry; other ones can be created manually by a site administrator and -are then registered automatically. - - -Server timezone ---------------- - -To manage timezones correctly, and display datetimes based on current server timezone, all datetimes should -be defined and stored in UTC. - -PyAMS_utils provides a :py:class:`ServerTimezoneUtility ` which -allows you to assign a default timezone to your server. - -To display a datetime with correct timezone, you can use the :py:func:`tztime ` function, -which assign server timezone to the given parameter: - -.. code-block:: python - - from datetime import datetime - from pyams_utils.timezone import tztime - - now = datetime.utcnow() - my_date = tztime(now) # converts *now* to server timezone - -We could imagine that datetimes could be displayed with current user timezone. But it's quite impossible to know -the user timazone from a server request. The only options are: - -- you ask an authenticated user to update a timezone setting in his profile - -- you can include Javascript libraries which will try to detect browser timezone from their computer configuration, and - do an AJAX request to update data in their session. - -That should require an update of :py:func:`tzinfo` adapter to get timezone info from session, request or user profile. - - -ZEO connection --------------- - -Several PyAMS utilities (like the tasks scheduler or the medias converter) are working with dedicated processes, -are connected to main PyAMS process through ØMQ, and use ZEO connections for their PyAMS database access. - -Clients of these processes have to send settings of the ZEO connections that they should use. - -The ZEOConnection utility can be created by the site manager through the web management interface (ZMI) from the -*Control panel*: - -.. image:: _static/zeo-add-menu.png - -ZEO connection creation form allows you to define all settings of a ZEO connection: - -.. image:: _static/zeo-add-form.png diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/zca.rst.txt --- a/src/build/html/_sources/zca.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,263 +0,0 @@ -.. _zca: - -Managing ZCA with PyAMS -======================= - -The **Zope Component Architecture** (aka ZCA) is used by the Pyramid framework "under the hood" to handle interfaces, -adapters and utilities. You don't **have to** use it in your own applications. But you can. - -The ZCA is mainly adding elements like **interfaces**, **adapters** and **utilities** to the Python language. It -allows you to write a framework or an application by using **components** which can be extended easily. - -You will find several useful resources about ZCA concepts on the internet. - - -Local utilities ---------------- - -In ZCA, a **utility** is a **registered** component which provides an **interface**. This interface is the -**contract** which defines features (list of attributes and methods) provided by the component which implements it. - -When a Pyramid application starts, a **global registry** is created to register a whole set of utilities and -adapters; this registration can be done via ZCML directives or via native Python code. -In addition, PyAMS allows you to define **local utilities**, which are stored and registered in the ZODB via a **site -manager**. - - -Defining site root ------------------- - -One of PyAMS pre-requisites is to use the ZODB, at least to store the site root application, it's configuration and a -set of local utilities. :ref:`site` describes application startup and **local site manager** initialization process. - -This site can be used to store **local utilities** whose configuration, which is easily available to site -administrators through management interface, is stored in the ZODB. - - -Registering global utilities ----------------------------- - -**Global utilities** are components providing an interface which are registered in the global registry. -PyAMS_utils package provides custom annotations to register global utilities without using ZCML. For example, a skin -is nothing more than a simple utility providing the *ISkin* interface: - -.. code-block:: python - - from pyams_default_theme.layer import IPyAMSDefaultLayer - from pyams_skin.interfaces import ISkin - from pyams_utils.registry import utility_config - - @utility_config(name='PyAMS default skin', provides=ISkin) - class PyAMSDefaultSkin(object): - """PyAMS default skin""" - - label = _("PyAMS default skin") - layer = IPyAMSDefaultLayer - -This annotation registers a utility, named *PyAMS default skin*, providing the *ISkin* interface. It's the developer -responsibility to provide all attributes and methods required by the provided interface. - - -Registering local utilities ---------------------------- - -A local utility is a persistent object, registered in a *local site manager*, and providing a specific interface (if -a component provides several interfaces, it can be registered several times). - -Some components can be required by a given package, and created automatically via the *pyams_upgrade* command line -script; this process relies on the *ISiteGenerations* interface, for example for the timezone utility, a component -provided by PyAMS_utils package to handle server timezone and display times correctly: - -.. code-block:: python - - from pyams_utils.interfaces.site import ISiteGenerations - from pyams_utils.interfaces.timezone import IServerTimezone - - from persistent import Persistent - from pyams_utils.registry import utility_config - from pyams_utils.site import check_required_utilities - from pyramid.events import subscriber - from zope.container.contained import Contained - from zope.interface import implementer - from zope.schema.fieldproperty import FieldProperty - - @implementer(IServerTimezone) - class ServerTimezoneUtility(Persistent, Contained): - - timezone = FieldProperty(IServerTimezone['timezone']) - - REQUIRED_UTILITIES = ((IServerTimezone, '', ServerTimezoneUtility, 'Server timezone'),) - - @subscriber(INewLocalSite) - def handle_new_local_site(event): - """Create a new ServerTimezoneUtility when a site is created""" - site = event.manager.__parent__ - check_required_utilities(site, REQUIRED_UTILITIES) - - @utility_config(name='PyAMS timezone', provides=ISiteGenerations) - class TimezoneGenerationsChecker(object): - """Timezone generations checker""" - - generation = 1 - - def evolve(self, site, current=None): - """Check for required utilities""" - check_required_utilities(site, REQUIRED_UTILITIES) - -Some utilities can also be created manually by an administrator through the management interface, and registered -automatically after their creation. For example, this is how a ZEO connection utility (which is managing settings to -define a ZEO connection) is registered: - -.. code-block:: python - - from pyams_utils.interfaces.site import IOptionalUtility - from pyams_utils.interfaces.zeo import IZEOConnection - from zope.annotation.interfaces import IAttributeAnnotatable - from zope.lifecycleevent.interfaces import IObjectAddedEvent, IObjectRemovedEvent - - from persistent import Persistent - from pyramid.events import subscriber - from zope.container.contained import Contained - - @implementer(IZEOConnection) - class ZEOConnection(object): - """ZEO connection object. See source code to get full implementation...""" - - @implementer(IOptionalUtility, IAttributeAnnotatable) - class ZEOConnectionUtility(ZEOConnection, Persistent, Contained): - """Persistent ZEO connection utility""" - - @subscriber(IObjectAddedEvent, context_selector=IZEOConnection) - def handle_added_connection(event): - """Register new ZEO connection when added""" - manager = event.newParent - manager.registerUtility(event.object, IZEOConnection, name=event.object.name) - - @subscriber(IObjectRemovedEvent, context_selector=IZEOConnection) - def handle_removed_connection(event): - """Un-register ZEO connection when deleted""" - manager = event.oldParent - manager.unregisterUtility(event.object, IZEOConnection, name=event.object.name) - -*context_selector* is a custom subscriber predicate, so that subscriber event is activated only if object concerned -by an event is providing given interface. - - -Looking for utilities ---------------------- - -ZCA provides the *getUtility* and *queryUtility* functions to look for a utility. But these methods only applies to -global registry. - -PyAMS package provides equivalent functions, which are looking for components into local registry before looking into -the global one. For example: - -.. code-block:: python - - from pyams_security.interfaces import ISecurityManager - from pyams_utils.registry import query_utility - - manager = query_utility(ISecurityManager) - if manager is not None: - print("Manager is there!") - -All ZCA utility functions have been ported to use local registry: *registered_utilities*, *query_utility*, -*get_utility*, *get_utilities_for*, *get_all_utilities_registered_for* functions all follow the equivalent ZCA -functions API, but are looking for utilities in the local registry before looking in the global registry. - - -Registering adapters --------------------- - -An adapter is also a kind of utility. But instead of *just* providing an interface, it adapts an input object, -providing a given interface, to provide another interface. An adapter can also be named, so that you can choose which -adapter to use at a given time. - -PyAMS_utils provide another annotation, to help registering adapters without using ZCML files. An adapter can be a -function which directly returns an object providing the requested interface, or an object which provides the interface. - -The first example is an adapter which adapts any persistent object to get it's associated transaction manager: - -.. code-block:: python - - from persistent.interfaces import IPersistent - from transaction.interfaces import ITransactionManager - from ZODB.interfaces import IConnection - - from pyams_utils.adapter import adapter_config - - @adapter_config(context=IPersistent, provides=ITransactionManager) - def get_transaction_manager(obj): - conn = IConnection(obj) - try: - return conn.transaction_manager - except AttributeError: - return conn._txn_mgr - -This is another adapter which adapts any contained object to the *IPathElements* interface; this interface can be -used to build index that you can use to find objects based on a parent object: - -.. code-block:: python - - from pyams_utils.interfaces.traversing import IPathElements - from zope.intid.interfaces import IIntIds - from zope.location.interfaces import IContained - - from pyams_utils.adapter import ContextAdapter - from pyams_utils.registry import query_utility - from pyramid.location import lineage - - @adapter_config(context=IContained, provides=IPathElements) - class PathElementsAdapter(ContextAdapter): - """Contained object path elements adapter""" - - @property - def parents(self): - intids = query_utility(IIntIds) - if intids is None: - return [] - return [intids.register(parent) for parent in lineage(self.context)] - -An adapter can also be a multi-adapter, when several input objects are requested to provide a given interface. For -example, many adapters require a context and a request, eventually a view, to provide another feature. This is how, -for example, we define a custom *name* column in a security manager table displaying a list of plug-ins: - -.. code-block:: python - - from pyams_zmi.layer import IAdminLayer - from z3c.table.interfaces import IColumn - - from pyams_skin.table import I18nColumn - from z3c.table.column import GetAttrColumn - - @adapter_config(name='name', context=(Interface, IAdminLayer, SecurityManagerPluginsTable), provides=IColumn) - class SecurityManagerPluginsNameColumn(I18nColumn, GetAttrColumn): - """Security manager plugins name column""" - - _header = _("Name") - attrName = 'title' - weight = 10 - -As you can see, adapted objects can be given as interfaces and/or as classes. - - -Registering vocabularies ------------------------- - -A **vocabulary** is a custom factory which can be used as source for several field types, like *choices* or *lists*. -Vocabularies have to be registered in a custom registry, so PyAMS_utils provide another annotation to register them. -This example is based on the *Timezone* component which allows you to select a timezone between a list of references: - -.. code-block:: python - - import pytz - from pyams_utils.vocabulary import vocabulary_config - from zope.schema.vocabulary import SimpleTerm, SimpleVocabulary - - @vocabulary_config(name='PyAMS timezones') - class TimezonesVocabulary(SimpleVocabulary): - """Timezones vocabulary""" - - def __init__(self, *args, **kw): - terms = [SimpleTerm(t, t, t) for t in pytz.all_timezones] - super(TimezonesVocabulary, self).__init__(terms) diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/zeo.rst.txt --- a/src/build/html/_sources/zeo.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,114 +0,0 @@ -.. _zeo: - -Creating a ZEO server -===================== - -PyAMS primarily relies on a ZODB database to store it's configuration. Other packages may rely on another -database, but *PyAMS_content* package also stores it's contents in a ZODB. - -As some PyAMS packages start concurrent processes ("synchronization" is done via **ØMQ**), concurrent accesses are -required on the ZODB (even when you start your application in "single process" mode) and a ZEO server have to be -started. - - -Creating initial buildout -------------------------- - -PyAMS provides a ZEO server scaffold, called *zeo_server*, generated via a *cookiecutter* template. - -A simple option to create a ZEO server is to create a buildout environment including *ZEO* and *ZODB* packages: - -.. code-block:: bash - - # mkdir /var/local/ - # pip3 install virtualenv - # virtualenv --python=python3.5 env - # cd env - # . bin/activate - (env) # pip3.5 install cookiecutter - (env) # cookiecutter hg+http://hg.ztfy.org/pyams/scaffolds/zeo_server - -*CookieCutter* will ask you for a small set of input variables that you can change or not: - -- **pyams_release**: version of PyAMS configuration file to use. "latest" (default value) will point to last release; - you can also choose to point to a given release ("0.1.4" for example) - -- **project_name**: current environment name in "human form" - -- **project_slug**: "technical" package name, based on project name - -- **eggs_directory**: relative or absolute path to directory containing downloaded eggs; this directory can be - shared with other projects ("eggs" as default) - -- **run_user**: user name under which ZEO process will run ("zeoadm" as default) - -- **run_group**: group name under which ZEO process will run ("zeo" as default) - -- **zeo_server_port**: listening port of ZEO server ("8100" as default) - -- **zeo_monitor_port**: listening port of ZEO monitor ("8101" as default) - -- **zeo_storage**: name of first ZEO storage; default value is based on project name - -- **use_zeo_auth**: specify if ZEO authentication should be used - -- **zeo_auth_user**: name of ZEO authenticated user (if ZEO authentication is used) - -- **zeo_auth_password**: password of ZEO authenticated user (if ZEO authentication is used) - -- **zeo_pack_report**: email address to which pack reports should be sent - -- **logs_directory**: absolute path to directory containing ZEO's log files. - -A message is displayed after initialization to finalize environment creation: - -.. code-block:: - - Your ZEO environment is initialized. - To finalize it's creation, just type: - - cd zeo_server - - python3.5 bootstrap.py - - ./bin/buildout - - To initialize authentication database, please run following command after buildout: - ./bin/zeopasswd -f etc/auth.db -p digest -r "ZEO_server" zeouser xxxx - - -ZEO server configuration ------------------------- - -All ZEO configuration files are generated in "etc" subdirectory. These includes: - -- **etc/zeo_server-zdaemon.conf**: ZDaemon configuration file - -- **etc/zeo_server-zeo.conf**: ZEO server configuration file - -- **etc/auth.db**: ZEO authentication file; WARNING: this file is not created automatically, you have to create it - after buildout. - -In these file names, always replace "zeo_server" with the value which was given to "project_slug" variable during -*CookieCutter* template creation. - - -ZEO server tools ----------------- - -A set of system configuration files are produced to handle your ZEO environment. These includes: - -- **etc/init.d/zeo-zeo_server**: ZEO server start/stop script in Init-D format. Create a link to this file in - */etc/init.d* and update Init.d scripts (*update-rc.d zeo-zeo_server defaults*) to include ZEO in server start/stop - process. You can also use this script to start/stop ZEO by hand with *start* and *stop* arguments. - -- **etc/systemd/zeo-zeo_server.service**: SystemD service configuration file for ZEO server. Create a link to this - file in */etc/systemd/system* and reload SystemD daemon (*systemctl daemon-reload*) before activating ZEO service - (*systemctl enable zeo-zeo_server.service* and *systemctl start zeo-zeo_server.service*). - -- **etc/logrotate.d/zeo-zeo_server**: LogRotate configuration file for ZEO log files. Create a link to this file in - */etc/logrotate.d* to activate log rotation for ZEO server. - -- **etc/cron.d/pack-zeo-zeo_server**: Cron configuration file for ZEO database packing. Just create a link to this - file in */etc/cron.d* directory to enable ZODB packing on a weekly basis (by default). - -In these file names, always replace "zeo_server" with the value which was given to "project_slug" variable during -*CookieCutter* template creation. All directory names are those used on a Debian GNU/Linux distribution and may have -to be changed on other distributions. diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_sources/zodb.rst.txt --- a/src/build/html/_sources/zodb.rst.txt Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,158 +0,0 @@ -.. _zodb: - -Creating ZODB -============= - -PyAMS primarily relies on a ZODB (Zope Objects DataBase) to store it's configuration. Other packages may -rely on other database(s), but *PyAMS_content* package also stores it's contents in a ZODB. - -As some PyAMS packages start several processes ("synchronization" is done via **ØMQ**), concurrent accesses are -required on the ZODB (even when you start your application in "single process" mode); several ZODB storages -implementations providing a shared access are available: `ZEO`_, `RelStorage`_ and `Newt.DB`_. - - -.. _ZEO: - -Installing a ZEO server -+++++++++++++++++++++++ - -ZEO (Zope Enterprise Objects) is the first available implementation available for concurrent access to a -FileStorage, provided through the ZEO package. - -ZEO package documentation and complete configuration settings are available on PyPI. - -Creating initial buildout -------------------------- - -PyAMS provides a ZEO server scaffold, called *zeo_server*, generated via a *cookiecutter* template. - -A simple option to create a ZEO server is to create a buildout environment including *ZEO* and *ZODB* packages: - -.. code-block:: bash - - # mkdir /var/local/ - # pip3 install virtualenv - # virtualenv --python=python3.5 env - # cd env - # . bin/activate - (env) # pip3.5 install cookiecutter - (env) # cookiecutter hg+http://hg.ztfy.org/pyams/scaffolds/zeo_server - -*CookieCutter* will ask you for a small set of input variables that you can change or not: - -- **pyams_release**: version of PyAMS configuration file to use. "latest" (default value) will point to last release; - you can also choose to point to a given release ("0.1.4" for example) - -- **project_name**: current environment name in "human form" - -- **project_slug**: "technical" package name, based on project name - -- **eggs_directory**: relative or absolute path to directory containing downloaded eggs; this directory can be - shared with other projects ("eggs" as default) - -- **run_user**: user name under which ZEO process will run ("zeoadm" as default) - -- **run_group**: group name under which ZEO process will run ("zeo" as default) - -- **zeo_server_port**: listening port of ZEO server ("8100" as default) - -- **zeo_monitor_port**: listening port of ZEO monitor ("8101" as default) - -- **zeo_storage**: name of first ZEO storage; default value is based on project name - -- **use_zeo_auth**: specify if ZEO authentication should be used - -- **zeo_auth_user**: name of ZEO authenticated user (if ZEO authentication is used) - -- **zeo_auth_password**: password of ZEO authenticated user (if ZEO authentication is used) - -- **zeo_pack_report**: email address to which pack reports should be sent - -- **logs_directory**: absolute path to directory containing ZEO's log files. - -A message is displayed after initialization to finalize environment creation: - -.. code:: - - Your ZEO environment is initialized. - To finalize it''s creation, just type: - - cd zeo_server - - python3.5 bootstrap.py - - ./bin/buildout - - To initialize authentication database, please run following command after buildout: - ./bin/zeopasswd -f etc/auth.db -p digest -r "ZEO_server" zeouser xxxx - -ZEO server configuration ------------------------- - -All ZEO configuration files are generated in "etc" subdirectory. These includes: - -- **etc/zeo_server-zdaemon.conf**: ZDaemon configuration file - -- **etc/zeo_server-zeo.conf**: ZEO server configuration file - -- **etc/auth.db**: ZEO authentication file; WARNING: this file is not created automatically, you have to create it - after buildout. - -In these file names, always replace "zeo_server" with the value which was given to "project_slug" variable during -*CookieCutter* template creation. - -ZEO server tools ----------------- - -A set of system configuration files are produced to handle your ZEO environment. These includes: - -- **etc/init.d/zeo-zeo_server**: ZEO server start/stop script in Init-D format. Create a link to this file in - */etc/init.d* and update Init.d scripts (*update-rc.d zeo-zeo_server defaults*) to include ZEO in server start/stop - process. You can also use this script to start/stop ZEO by hand with *start* and *stop* arguments. - -- **etc/systemd/zeo-zeo_server.service**: SystemD service configuration file for ZEO server. Create a link to this - file in */etc/systemd/system* and reload SystemD daemon (*systemctl daemon-reload*) before activating ZEO service - (*systemctl enable zeo-zeo_server.service* and *systemctl start zeo-zeo_server.service*). - -- **etc/logrotate.d/zeo-zeo_server**: LogRotate configuration file for ZEO log files. Create a link to this file in - */etc/logrotate.d* to activate log rotation for ZEO server. - -- **etc/cron.d/pack-zeo-zeo_server**: Cron configuration file for ZEO database packing. Just create a link to this - file in */etc/cron.d* directory to enable ZODB packing on a weekly basis (by default). - -In these file names, always replace "zeo_server" with the value which was given to "project_slug" variable during -*CookieCutter* template creation. All directory names are those used on a Debian GNU/Linux distribution and may have -to be changed on other distributions. - - -.. _RelStorage: - -Installing a RelStorage server -++++++++++++++++++++++++++++++ - -RelStorage (http://relstorage.readthedocs.io/en/latest) is an alternate ZODB storage implementation, that stores -Python pickles in a relational database; PostgreSQL (>= 9.0), MySQL (>= 5.0.32) and Oracle (> 10g) databases are -supported. - -To create a database compatible with RelStorage, you just have to install the database server and create a database -dedicated to RelStorage; schema initialization is then completely done by RelStorage on application startup. - -RelStorage is supposed to provide better performances than ZEO, notably under high load. RelStorage can also get -benefit from many extensions (clustering, fail-over, hot-standby...) provided by these databases. - - -.. _Newt.DB: - -Installing a NewtDB server -++++++++++++++++++++++++++ - -NewtDB (http://www.newtdb.org/en/latest) is another ZODB storage implementation. It's using RelStorage but is -dedicated to PostgreSQL (>= 9.5). - -NewtDB adds conversion of data from the native serialization used by ZODB to JSON, stored in a PostgreSQL JSONB -column. The JSON data supplements the native data to support indexing, search, and access from non-Python application. -Because the JSON format is lossy, compared to the native format, the native format is still used for loading -objects from the database. For this reason, the JSON data are read-only. - -Newt adds a search API for searching the Postgres JSON data and returning persistent objects. It also provides a -convenient API for raw data searches. - -Database creation is done as with RelStorage, but NewtDB add several schema objects. Migration scripts are available -if you need to switch from a classic RelStorage database to a Newt database. diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_static/ajax-loader.gif Binary file src/build/html/_static/ajax-loader.gif has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_static/dialog-seealso.png Binary file src/build/html/_static/dialog-seealso.png has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_static/dialog-warning.png Binary file src/build/html/_static/dialog-warning.png has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_static/doctools.js --- a/src/build/html/_static/doctools.js Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,311 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for all documentation. - * - * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var bbox = span.getBBox(); - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - var parentOfText = node.parentNode.parentNode; - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; -}; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, - LOCALE : 'unknown', - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated === 'undefined') - return string; - return (typeof translated === 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated === 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); - }, - - /** - * workaround a firefox stupidity - * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash) - window.setTimeout(function() { - document.location.href += ''; - }, 10); - }, - - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - if (!body.length) { - body = $('body'); - } - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); - } - }, - - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) === 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this === '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - }, - - initOnKeyListeners: function() { - $(document).keyup(function(event) { - var activeElementType = document.activeElement.tagName; - // don't navigate when in search box or textarea - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { - switch (event.keyCode) { - case 37: // left - var prevHref = $('link[rel="prev"]').prop('href'); - if (prevHref) { - window.location.href = prevHref; - return false; - } - case 39: // right - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; - } - } - } - }); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_static/down-pressed.png Binary file src/build/html/_static/down-pressed.png has changed diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_static/epub.css --- a/src/build/html/_static/epub.css Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,310 +0,0 @@ -/* - * default.css_t - * ~~~~~~~~~~~~~ - * - * Sphinx stylesheet -- default theme. - * - * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: {{ theme_bodyfont }}; - font-size: 100%; - background-color: {{ theme_footerbgcolor }}; - color: #000; - margin: 0; - padding: 0; -} - -div.document { - background-color: {{ theme_sidebarbgcolor }}; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 230px; -} - -div.body { - background-color: {{ theme_bgcolor }}; - color: {{ theme_textcolor }}; - padding: 0 20px 30px 20px; -} - -{%- if theme_rightsidebar|tobool %} -div.bodywrapper { - margin: 0 230px 0 0; -} -{%- endif %} - -div.footer { - color: {{ theme_footertextcolor }}; - width: 100%; - padding: 9px 0 9px 0; - text-align: center; - font-size: 75%; -} - -div.footer a { - color: {{ theme_footertextcolor }}; - text-decoration: underline; -} - -div.related { - background-color: {{ theme_relbarbgcolor }}; - line-height: 30px; - color: {{ theme_relbartextcolor }}; -} - -div.related a { - color: {{ theme_relbarlinkcolor }}; -} - -div.sphinxsidebar { - {%- if theme_stickysidebar|tobool %} - top: 30px; - bottom: 0; - margin: 0; - position: fixed; - overflow: auto; - height: auto; - {%- endif %} - {%- if theme_rightsidebar|tobool %} - float: right; - {%- if theme_stickysidebar|tobool %} - right: 0; - {%- endif %} - {%- endif %} -} - -{%- if theme_stickysidebar|tobool %} -/* this is nice, but it it leads to hidden headings when jumping - to an anchor */ -/* -div.related { - position: fixed; -} - -div.documentwrapper { - margin-top: 30px; -} -*/ -{%- endif %} - -div.sphinxsidebar h3 { - font-family: {{ theme_headfont }}; - color: {{ theme_sidebartextcolor }}; - font-size: 1.4em; - font-weight: normal; - margin: 0; - padding: 0; -} - -div.sphinxsidebar h3 a { - color: {{ theme_sidebartextcolor }}; -} - -div.sphinxsidebar h4 { - font-family: {{ theme_headfont }}; - color: {{ theme_sidebartextcolor }}; - font-size: 1.3em; - font-weight: normal; - margin: 5px 0 0 0; - padding: 0; -} - -div.sphinxsidebar p { - color: {{ theme_sidebartextcolor }}; -} - -div.sphinxsidebar p.topless { - margin: 5px 10px 10px 10px; -} - -div.sphinxsidebar ul { - margin: 10px; - padding: 0; - color: {{ theme_sidebartextcolor }}; -} - -div.sphinxsidebar a { - color: {{ theme_sidebarlinkcolor }}; -} - -div.sphinxsidebar input { - border: 1px solid {{ theme_sidebarlinkcolor }}; - font-family: sans-serif; - font-size: 1em; -} - -{% if theme_collapsiblesidebar|tobool %} -/* for collapsible sidebar */ -div#sidebarbutton { - background-color: {{ theme_sidebarbtncolor }}; -} -{% endif %} - -/* -- hyperlink styles ------------------------------------------------------ */ - -a { - color: {{ theme_linkcolor }}; - text-decoration: none; -} - -a:visited { - color: {{ theme_visitedlinkcolor }}; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - -{% if theme_externalrefs|tobool %} -a.external { - text-decoration: none; - border-bottom: 1px dashed {{ theme_linkcolor }}; -} - -a.external:hover { - text-decoration: none; - border-bottom: none; -} - -a.external:visited { - text-decoration: none; - border-bottom: 1px dashed {{ theme_visitedlinkcolor }}; -} -{% endif %} - -/* -- body styles ----------------------------------------------------------- */ - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: {{ theme_headfont }}; - background-color: {{ theme_headbgcolor }}; - font-weight: normal; - color: {{ theme_headtextcolor }}; - border-bottom: 1px solid #ccc; - margin: 20px -20px 10px -20px; - padding: 3px 0 3px 10px; -} - -div.body h1 { margin-top: 0; font-size: 200%; } -div.body h2 { font-size: 160%; } -div.body h3 { font-size: 140%; } -div.body h4 { font-size: 120%; } -div.body h5 { font-size: 110%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: {{ theme_headlinkcolor }}; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: {{ theme_headlinkcolor }}; - color: white; -} - -div.body p, div.body dd, div.body li { - text-align: justify; - line-height: 130%; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.admonition p { - margin-bottom: 5px; -} - -div.admonition pre { - margin-bottom: 5px; -} - -div.admonition ul, div.admonition ol { - margin-bottom: 5px; -} - -div.note { - background-color: #eee; - border: 1px solid #ccc; -} - -div.seealso { - background-color: #ffc; - border: 1px solid #ff6; -} - -div.topic { - background-color: #eee; -} - -div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre { - padding: 5px; - background-color: {{ theme_codebgcolor }}; - color: {{ theme_codetextcolor }}; - line-height: 120%; - border: 1px solid #ac9; - border-left: none; - border-right: none; -} - -code { - background-color: #ecf0f3; - padding: 0 1px 0 1px; - font-size: 0.95em; -} - -th { - background-color: #ede; -} - -.warning code { - background: #efc2c2; -} - -.note code { - background: #d6d6d6; -} - -.viewcode-back { - font-family: {{ theme_bodyfont }}; -} - -div.viewcode-block:target { - background-color: #f4debf; - border-top: 1px solid #ac9; - border-bottom: 1px solid #ac9; -} diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_static/ie6.css --- a/src/build/html/_static/ie6.css Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,7 +0,0 @@ -* html img, -* html .png{position:relative;behavior:expression((this.runtimeStyle.behavior="none")&&(this.pngSet?this.pngSet=true:(this.nodeName == "IMG" && this.src.toLowerCase().indexOf('.png')>-1?(this.runtimeStyle.backgroundImage = "none", -this.runtimeStyle.filter = "progid:DXImageTransform.Microsoft.AlphaImageLoader(src='" + this.src + "',sizingMethod='image')", -this.src = "_static/transparent.gif"):(this.origBg = this.origBg? this.origBg :this.currentStyle.backgroundImage.toString().replace('url("','').replace('")',''), -this.runtimeStyle.filter = "progid:DXImageTransform.Microsoft.AlphaImageLoader(src='" + this.origBg + "',sizingMethod='crop')", -this.runtimeStyle.backgroundImage = "none")),this.pngSet=true) -);} diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/_static/jquery.min.js --- a/src/build/html/_static/jquery.min.js Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1 +0,0 @@ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(e,t){"use strict";function n(e,t){var n=(t=t||K).createElement("script");n.text=e,t.head.appendChild(n).parentNode.removeChild(n)}function r(e){var t=!!e&&"length"in e&&e.length,n=fe.type(e);return"function"!==n&&!fe.isWindow(e)&&("array"===n||0===t||"number"==typeof t&&t>0&&t-1 in e)}function i(e,t,n){if(fe.isFunction(t))return fe.grep(e,function(e,r){return!!t.call(e,r,e)!==n});if(t.nodeType)return fe.grep(e,function(e){return e===t!==n});if("string"==typeof t){if(we.test(t))return fe.filter(t,e,n);t=fe.filter(t,e)}return fe.grep(e,function(e){return re.call(t,e)>-1!==n&&1===e.nodeType})}function o(e,t){for(;(e=e[t])&&1!==e.nodeType;);return e}function a(e){var t={};return fe.each(e.match(Se)||[],function(e,n){t[n]=!0}),t}function s(e){return e}function u(e){throw e}function l(e,t,n){var r;try{e&&fe.isFunction(r=e.promise)?r.call(e).done(t).fail(n):e&&fe.isFunction(r=e.then)?r.call(e,t,n):t.call(void 0,e)}catch(e){n.call(void 0,e)}}function c(){K.removeEventListener("DOMContentLoaded",c),e.removeEventListener("load",c),fe.ready()}function f(){this.expando=fe.expando+f.uid++}function p(e,t,n){var r;if(void 0===n&&1===e.nodeType)if(r="data-"+t.replace(Fe,"-$&").toLowerCase(),"string"==typeof(n=e.getAttribute(r))){try{n="true"===n||"false"!==n&&("null"===n?null:+n+""===n?+n:He.test(n)?JSON.parse(n):n)}catch(e){}Le.set(e,t,n)}else n=void 0;return n}function d(e,t,n,r){var i,o=1,a=20,s=r?function(){return r.cur()}:function(){return fe.css(e,t,"")},u=s(),l=n&&n[3]||(fe.cssNumber[t]?"":"px"),c=(fe.cssNumber[t]||"px"!==l&&+u)&&Pe.exec(fe.css(e,t));if(c&&c[3]!==l){l=l||c[3],n=n||[],c=+u||1;do{o=o||".5",c/=o,fe.style(e,t,c+l)}while(o!==(o=s()/u)&&1!==o&&--a)}return n&&(c=+c||+u||0,i=n[1]?c+(n[1]+1)*n[2]:+n[2],r&&(r.unit=l,r.start=c,r.end=i)),i}function h(e){var t,n=e.ownerDocument,r=e.nodeName,i=We[r];return i||(t=n.body.appendChild(n.createElement(r)),i=fe.css(t,"display"),t.parentNode.removeChild(t),"none"===i&&(i="block"),We[r]=i,i)}function g(e,t){for(var n,r,i=[],o=0,a=e.length;o-1)i&&i.push(o);else if(l=fe.contains(o.ownerDocument,o),a=m(f.appendChild(o),"script"),l&&v(a),n)for(c=0;o=a[c++];)_e.test(o.type||"")&&n.push(o);return f}function x(){return!0}function b(){return!1}function w(){try{return K.activeElement}catch(e){}}function T(e,t,n,r,i,o){var a,s;if("object"==typeof t){"string"!=typeof n&&(r=r||n,n=void 0);for(s in t)T(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=b;else if(!i)return e;return 1===o&&(a=i,i=function(e){return fe().off(e),a.apply(this,arguments)},i.guid=a.guid||(a.guid=fe.guid++)),e.each(function(){fe.event.add(this,t,i,r,n)})}function C(e,t){return fe.nodeName(e,"table")&&fe.nodeName(11!==t.nodeType?t:t.firstChild,"tr")?e.getElementsByTagName("tbody")[0]||e:e}function k(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function E(e){var t=Ze.exec(e.type);return t?e.type=t[1]:e.removeAttribute("type"),e}function S(e,t){var n,r,i,o,a,s,u,l;if(1===t.nodeType){if(qe.hasData(e)&&(o=qe.access(e),a=qe.set(t,o),l=o.events)){delete a.handle,a.events={};for(i in l)for(n=0,r=l[i].length;n1&&"string"==typeof h&&!le.checkClone&&Ke.test(h))return e.each(function(n){var o=e.eq(n);g&&(t[0]=h.call(this,n,o.html())),D(o,t,r,i)});if(p&&(o=y(t,e[0].ownerDocument,!1,e,i),a=o.firstChild,1===o.childNodes.length&&(o=a),a||i)){for(u=(s=fe.map(m(o,"script"),k)).length;f=0&&nw.cacheLength&&delete e[t.shift()],e[n+" "]=r}var t=[];return e}function r(e){return e[M]=!0,e}function i(e){var t=q.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function o(e,t){for(var n=e.split("|"),r=n.length;r--;)w.attrHandle[n[r]]=t}function a(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)for(;n=n.nextSibling;)if(n===t)return-1;return e?1:-1}function s(e){return function(t){return"label"in t&&t.disabled===e||"form"in t&&t.disabled===e||"form"in t&&!1===t.disabled&&(t.isDisabled===e||t.isDisabled!==!e&&("label"in t||!Te(t))!==e)}}function u(e){return r(function(t){return t=+t,r(function(n,r){for(var i,o=e([],n.length,t),a=o.length;a--;)n[i=o[a]]&&(n[i]=!(r[i]=n[i]))})})}function l(e){return e&&void 0!==e.getElementsByTagName&&e}function c(){}function f(e){for(var t=0,n=e.length,r="";t1?function(t,n,r){for(var i=e.length;i--;)if(!e[i](t,n,r))return!1;return!0}:e[0]}function h(e,n,r){for(var i=0,o=n.length;i-1&&(r[l]=!(a[l]=f))}}else x=g(x===a?x.splice(m,x.length):x),o?o(null,a,x,u):Q.apply(a,x)})}function v(e){for(var t,n,r,i=e.length,o=w.relative[e[0].type],a=o||w.relative[" "],s=o?1:0,u=p(function(e){return e===t},a,!0),l=p(function(e){return K(t,e)>-1},a,!0),c=[function(e,n,r){var i=!o&&(r||n!==N)||((t=n).nodeType?u(e,n,r):l(e,n,r));return t=null,i}];s1&&d(c),s>1&&f(e.slice(0,s-1).concat({value:" "===e[s-2].type?"*":""})).replace(oe,"$1"),n,s0,o=e.length>0,a=function(r,a,s,u,l){var c,f,p,d=0,h="0",m=r&&[],v=[],y=N,x=r||o&&w.find.TAG("*",l),b=W+=null==y?1:Math.random()||.1,T=x.length;for(l&&(N=a===q||a||l);h!==T&&null!=(c=x[h]);h++){if(o&&c){for(f=0,a||c.ownerDocument===q||(A(c),s=!H);p=e[f++];)if(p(c,a||q,s)){u.push(c);break}l&&(W=b)}i&&((c=!p&&c)&&d--,r&&m.push(c))}if(d+=h,i&&h!==d){for(f=0;p=n[f++];)p(m,v,a,s);if(r){if(d>0)for(;h--;)m[h]||v[h]||(v[h]=G.call(u));v=g(v)}Q.apply(u,v),l&&!r&&v.length>0&&d+n.length>1&&t.uniqueSort(u)}return l&&(W=b,N=y),m};return i?r(a):a}var x,b,w,T,C,k,E,S,N,D,j,A,q,L,H,F,O,P,R,M="sizzle"+1*new Date,I=e.document,W=0,$=0,B=n(),_=n(),z=n(),X=function(e,t){return e===t&&(j=!0),0},U={}.hasOwnProperty,V=[],G=V.pop,Y=V.push,Q=V.push,J=V.slice,K=function(e,t){for(var n=0,r=e.length;n+~]|"+ee+")"+ee+"*"),ue=new RegExp("="+ee+"*([^\\]'\"]*?)"+ee+"*\\]","g"),le=new RegExp(re),ce=new RegExp("^"+te+"$"),fe={ID:new RegExp("^#("+te+")"),CLASS:new RegExp("^\\.("+te+")"),TAG:new RegExp("^("+te+"|[*])"),ATTR:new RegExp("^"+ne),PSEUDO:new RegExp("^"+re),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ee+"*(even|odd|(([+-]|)(\\d*)n|)"+ee+"*(?:([+-]|)"+ee+"*(\\d+)|))"+ee+"*\\)|)","i"),bool:new RegExp("^(?:"+Z+")$","i"),needsContext:new RegExp("^"+ee+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ee+"*((?:-\\d)?\\d*)"+ee+"*\\)|)(?=[^-]|$)","i")},pe=/^(?:input|select|textarea|button)$/i,de=/^h\d$/i,he=/^[^{]+\{\s*\[native \w/,ge=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,me=/[+~]/,ve=new RegExp("\\\\([\\da-f]{1,6}"+ee+"?|("+ee+")|.)","ig"),ye=function(e,t,n){var r="0x"+t-65536;return r!==r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},xe=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\x80-\uFFFF\w-]/g,be=function(e,t){return t?"\0"===e?"�":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},we=function(){A()},Te=p(function(e){return!0===e.disabled},{dir:"parentNode",next:"legend"});try{Q.apply(V=J.call(I.childNodes),I.childNodes),V[I.childNodes.length].nodeType}catch(e){Q={apply:V.length?function(e,t){Y.apply(e,J.call(t))}:function(e,t){for(var n=e.length,r=0;e[n++]=t[r++];);e.length=n-1}}}b=t.support={},C=t.isXML=function(e){var t=e&&(e.ownerDocument||e).documentElement;return!!t&&"HTML"!==t.nodeName},A=t.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:I;return r!==q&&9===r.nodeType&&r.documentElement?(q=r,L=q.documentElement,H=!C(q),I!==q&&(n=q.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",we,!1):n.attachEvent&&n.attachEvent("onunload",we)),b.attributes=i(function(e){return e.className="i",!e.getAttribute("className")}),b.getElementsByTagName=i(function(e){return e.appendChild(q.createComment("")),!e.getElementsByTagName("*").length}),b.getElementsByClassName=he.test(q.getElementsByClassName),b.getById=i(function(e){return L.appendChild(e).id=M,!q.getElementsByName||!q.getElementsByName(M).length}),b.getById?(w.find.ID=function(e,t){if(void 0!==t.getElementById&&H){var n=t.getElementById(e);return n?[n]:[]}},w.filter.ID=function(e){var t=e.replace(ve,ye);return function(e){return e.getAttribute("id")===t}}):(delete w.find.ID,w.filter.ID=function(e){var t=e.replace(ve,ye);return function(e){var n=void 0!==e.getAttributeNode&&e.getAttributeNode("id");return n&&n.value===t}}),w.find.TAG=b.getElementsByTagName?function(e,t){return void 0!==t.getElementsByTagName?t.getElementsByTagName(e):b.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){for(;n=o[i++];)1===n.nodeType&&r.push(n);return r}return o},w.find.CLASS=b.getElementsByClassName&&function(e,t){if(void 0!==t.getElementsByClassName&&H)return t.getElementsByClassName(e)},O=[],F=[],(b.qsa=he.test(q.querySelectorAll))&&(i(function(e){L.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&F.push("[*^$]="+ee+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||F.push("\\["+ee+"*(?:value|"+Z+")"),e.querySelectorAll("[id~="+M+"-]").length||F.push("~="),e.querySelectorAll(":checked").length||F.push(":checked"),e.querySelectorAll("a#"+M+"+*").length||F.push(".#.+[+~]")}),i(function(e){e.innerHTML="";var t=q.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&F.push("name"+ee+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&F.push(":enabled",":disabled"),L.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&F.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),F.push(",.*:")})),(b.matchesSelector=he.test(P=L.matches||L.webkitMatchesSelector||L.mozMatchesSelector||L.oMatchesSelector||L.msMatchesSelector))&&i(function(e){b.disconnectedMatch=P.call(e,"*"),P.call(e,"[s!='']:x"),O.push("!=",re)}),F=F.length&&new RegExp(F.join("|")),O=O.length&&new RegExp(O.join("|")),t=he.test(L.compareDocumentPosition),R=t||he.test(L.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)for(;t=t.parentNode;)if(t===e)return!0;return!1},X=t?function(e,t){if(e===t)return j=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)===(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!b.sortDetached&&t.compareDocumentPosition(e)===n?e===q||e.ownerDocument===I&&R(I,e)?-1:t===q||t.ownerDocument===I&&R(I,t)?1:D?K(D,e)-K(D,t):0:4&n?-1:1)}:function(e,t){if(e===t)return j=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,s=[e],u=[t];if(!i||!o)return e===q?-1:t===q?1:i?-1:o?1:D?K(D,e)-K(D,t):0;if(i===o)return a(e,t);for(n=e;n=n.parentNode;)s.unshift(n);for(n=t;n=n.parentNode;)u.unshift(n);for(;s[r]===u[r];)r++;return r?a(s[r],u[r]):s[r]===I?-1:u[r]===I?1:0},q):q},t.matches=function(e,n){return t(e,null,null,n)},t.matchesSelector=function(e,n){if((e.ownerDocument||e)!==q&&A(e),n=n.replace(ue,"='$1']"),b.matchesSelector&&H&&!z[n+" "]&&(!O||!O.test(n))&&(!F||!F.test(n)))try{var r=P.call(e,n);if(r||b.disconnectedMatch||e.document&&11!==e.document.nodeType)return r}catch(e){}return t(n,q,null,[e]).length>0},t.contains=function(e,t){return(e.ownerDocument||e)!==q&&A(e),R(e,t)},t.attr=function(e,t){(e.ownerDocument||e)!==q&&A(e);var n=w.attrHandle[t.toLowerCase()],r=n&&U.call(w.attrHandle,t.toLowerCase())?n(e,t,!H):void 0;return void 0!==r?r:b.attributes||!H?e.getAttribute(t):(r=e.getAttributeNode(t))&&r.specified?r.value:null},t.escape=function(e){return(e+"").replace(xe,be)},t.error=function(e){throw new Error("Syntax error, unrecognized expression: "+e)},t.uniqueSort=function(e){var t,n=[],r=0,i=0;if(j=!b.detectDuplicates,D=!b.sortStable&&e.slice(0),e.sort(X),j){for(;t=e[i++];)t===e[i]&&(r=n.push(i));for(;r--;)e.splice(n[r],1)}return D=null,e},T=t.getText=function(e){var t,n="",r=0,i=e.nodeType;if(i){if(1===i||9===i||11===i){if("string"==typeof e.textContent)return e.textContent;for(e=e.firstChild;e;e=e.nextSibling)n+=T(e)}else if(3===i||4===i)return e.nodeValue}else for(;t=e[r++];)n+=T(t);return n},(w=t.selectors={cacheLength:50,createPseudo:r,match:fe,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(ve,ye),e[3]=(e[3]||e[4]||e[5]||"").replace(ve,ye),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||t.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&t.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return fe.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&le.test(n)&&(t=k(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(ve,ye).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=B[e+" "];return t||(t=new RegExp("(^|"+ee+")"+e+"("+ee+"|$)"))&&B(e,function(e){return t.test("string"==typeof e.className&&e.className||void 0!==e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(e,n,r){return function(i){var o=t.attr(i,e);return null==o?"!="===n:!n||(o+="","="===n?o===r:"!="===n?o!==r:"^="===n?r&&0===o.indexOf(r):"*="===n?r&&o.indexOf(r)>-1:"$="===n?r&&o.slice(-r.length)===r:"~="===n?(" "+o.replace(ie," ")+" ").indexOf(r)>-1:"|="===n&&(o===r||o.slice(0,r.length+1)===r+"-"))}},CHILD:function(e,t,n,r,i){var o="nth"!==e.slice(0,3),a="last"!==e.slice(-4),s="of-type"===t;return 1===r&&0===i?function(e){return!!e.parentNode}:function(t,n,u){var l,c,f,p,d,h,g=o!==a?"nextSibling":"previousSibling",m=t.parentNode,v=s&&t.nodeName.toLowerCase(),y=!u&&!s,x=!1;if(m){if(o){for(;g;){for(p=t;p=p[g];)if(s?p.nodeName.toLowerCase()===v:1===p.nodeType)return!1;h=g="only"===e&&!h&&"nextSibling"}return!0}if(h=[a?m.firstChild:m.lastChild],a&&y){for(x=(d=(l=(c=(f=(p=m)[M]||(p[M]={}))[p.uniqueID]||(f[p.uniqueID]={}))[e]||[])[0]===W&&l[1])&&l[2],p=d&&m.childNodes[d];p=++d&&p&&p[g]||(x=d=0)||h.pop();)if(1===p.nodeType&&++x&&p===t){c[e]=[W,d,x];break}}else if(y&&(p=t,f=p[M]||(p[M]={}),c=f[p.uniqueID]||(f[p.uniqueID]={}),l=c[e]||[],d=l[0]===W&&l[1],x=d),!1===x)for(;(p=++d&&p&&p[g]||(x=d=0)||h.pop())&&((s?p.nodeName.toLowerCase()!==v:1!==p.nodeType)||!++x||(y&&(f=p[M]||(p[M]={}),c=f[p.uniqueID]||(f[p.uniqueID]={}),c[e]=[W,x]),p!==t)););return(x-=i)===r||x%r==0&&x/r>=0}}},PSEUDO:function(e,n){var i,o=w.pseudos[e]||w.setFilters[e.toLowerCase()]||t.error("unsupported pseudo: "+e);return o[M]?o(n):o.length>1?(i=[e,e,"",n],w.setFilters.hasOwnProperty(e.toLowerCase())?r(function(e,t){for(var r,i=o(e,n),a=i.length;a--;)r=K(e,i[a]),e[r]=!(t[r]=i[a])}):function(e){return o(e,0,i)}):o}},pseudos:{not:r(function(e){var t=[],n=[],i=E(e.replace(oe,"$1"));return i[M]?r(function(e,t,n,r){for(var o,a=i(e,null,r,[]),s=e.length;s--;)(o=a[s])&&(e[s]=!(t[s]=o))}):function(e,r,o){return t[0]=e,i(t,null,o,n),t[0]=null,!n.pop()}}),has:r(function(e){return function(n){return t(e,n).length>0}}),contains:r(function(e){return e=e.replace(ve,ye),function(t){return(t.textContent||t.innerText||T(t)).indexOf(e)>-1}}),lang:r(function(e){return ce.test(e||"")||t.error("unsupported lang: "+e),e=e.replace(ve,ye).toLowerCase(),function(t){var n;do{if(n=H?t.lang:t.getAttribute("xml:lang")||t.getAttribute("lang"))return(n=n.toLowerCase())===e||0===n.indexOf(e+"-")}while((t=t.parentNode)&&1===t.nodeType);return!1}}),target:function(t){var n=e.location&&e.location.hash;return n&&n.slice(1)===t.id},root:function(e){return e===L},focus:function(e){return e===q.activeElement&&(!q.hasFocus||q.hasFocus())&&!!(e.type||e.href||~e.tabIndex)},enabled:s(!1),disabled:s(!0),checked:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&!!e.checked||"option"===t&&!!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,!0===e.selected},empty:function(e){for(e=e.firstChild;e;e=e.nextSibling)if(e.nodeType<6)return!1;return!0},parent:function(e){return!w.pseudos.empty(e)},header:function(e){return de.test(e.nodeName)},input:function(e){return pe.test(e.nodeName)},button:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&"button"===e.type||"button"===t},text:function(e){var t;return"input"===e.nodeName.toLowerCase()&&"text"===e.type&&(null==(t=e.getAttribute("type"))||"text"===t.toLowerCase())},first:u(function(){return[0]}),last:u(function(e,t){return[t-1]}),eq:u(function(e,t,n){return[n<0?n+t:n]}),even:u(function(e,t){for(var n=0;n=0;)e.push(r);return e}),gt:u(function(e,t,n){for(var r=n<0?n+t:n;++r2&&"ID"===(a=o[0]).type&&b.getById&&9===t.nodeType&&H&&w.relative[o[1].type]){if(!(t=(w.find.ID(a.matches[0].replace(ve,ye),t)||[])[0]))return n;c&&(t=t.parentNode),e=e.slice(o.shift().value.length)}for(i=fe.needsContext.test(e)?0:o.length;i--&&(a=o[i],!w.relative[s=a.type]);)if((u=w.find[s])&&(r=u(a.matches[0].replace(ve,ye),me.test(o[0].type)&&l(t.parentNode)||t))){if(o.splice(i,1),!(e=r.length&&f(o)))return Q.apply(n,r),n;break}}return(c||E(e,p))(r,t,!H,n,!t||me.test(e)&&l(t.parentNode)||t),n},b.sortStable=M.split("").sort(X).join("")===M,b.detectDuplicates=!!j,A(),b.sortDetached=i(function(e){return 1&e.compareDocumentPosition(q.createElement("fieldset"))}),i(function(e){return e.innerHTML="","#"===e.firstChild.getAttribute("href")})||o("type|href|height|width",function(e,t,n){if(!n)return e.getAttribute(t,"type"===t.toLowerCase()?1:2)}),b.attributes&&i(function(e){return e.innerHTML="",e.firstChild.setAttribute("value",""),""===e.firstChild.getAttribute("value")})||o("value",function(e,t,n){if(!n&&"input"===e.nodeName.toLowerCase())return e.defaultValue}),i(function(e){return null==e.getAttribute("disabled")})||o(Z,function(e,t,n){var r;if(!n)return!0===e[t]?t.toLowerCase():(r=e.getAttributeNode(t))&&r.specified?r.value:null}),t}(e);fe.find=me,fe.expr=me.selectors,fe.expr[":"]=fe.expr.pseudos,fe.uniqueSort=fe.unique=me.uniqueSort,fe.text=me.getText,fe.isXMLDoc=me.isXML,fe.contains=me.contains,fe.escapeSelector=me.escape;var ve=function(e,t,n){for(var r=[],i=void 0!==n;(e=e[t])&&9!==e.nodeType;)if(1===e.nodeType){if(i&&fe(e).is(n))break;r.push(e)}return r},ye=function(e,t){for(var n=[];e;e=e.nextSibling)1===e.nodeType&&e!==t&&n.push(e);return n},xe=fe.expr.match.needsContext,be=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i,we=/^.[^:#\[\.,]*$/;fe.filter=function(e,t,n){var r=t[0];return n&&(e=":not("+e+")"),1===t.length&&1===r.nodeType?fe.find.matchesSelector(r,e)?[r]:[]:fe.find.matches(e,fe.grep(t,function(e){return 1===e.nodeType}))},fe.fn.extend({find:function(e){var t,n,r=this.length,i=this;if("string"!=typeof e)return this.pushStack(fe(e).filter(function(){for(t=0;t1?fe.uniqueSort(n):n},filter:function(e){return this.pushStack(i(this,e||[],!1))},not:function(e){return this.pushStack(i(this,e||[],!0))},is:function(e){return!!i(this,"string"==typeof e&&xe.test(e)?fe(e):e||[],!1).length}});var Te,Ce=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/;(fe.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||Te,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&e.length>=3?[null,e,null]:Ce.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof fe?t[0]:t,fe.merge(this,fe.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:K,!0)),be.test(r[1])&&fe.isPlainObject(t))for(r in t)fe.isFunction(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=K.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):fe.isFunction(e)?void 0!==n.ready?n.ready(e):e(fe):fe.makeArray(e,this)}).prototype=fe.fn,Te=fe(K);var ke=/^(?:parents|prev(?:Until|All))/,Ee={children:!0,contents:!0,next:!0,prev:!0};fe.fn.extend({has:function(e){var t=fe(e,this),n=t.length;return this.filter(function(){for(var e=0;e-1:1===n.nodeType&&fe.find.matchesSelector(n,e))){o.push(n);break}return this.pushStack(o.length>1?fe.uniqueSort(o):o)},index:function(e){return e?"string"==typeof e?re.call(fe(e),this[0]):re.call(this,e.jquery?e[0]:e):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(e,t){return this.pushStack(fe.uniqueSort(fe.merge(this.get(),fe(e,t))))},addBack:function(e){return this.add(null==e?this.prevObject:this.prevObject.filter(e))}}),fe.each({parent:function(e){var t=e.parentNode;return t&&11!==t.nodeType?t:null},parents:function(e){return ve(e,"parentNode")},parentsUntil:function(e,t,n){return ve(e,"parentNode",n)},next:function(e){return o(e,"nextSibling")},prev:function(e){return o(e,"previousSibling")},nextAll:function(e){return ve(e,"nextSibling")},prevAll:function(e){return ve(e,"previousSibling")},nextUntil:function(e,t,n){return ve(e,"nextSibling",n)},prevUntil:function(e,t,n){return ve(e,"previousSibling",n)},siblings:function(e){return ye((e.parentNode||{}).firstChild,e)},children:function(e){return ye(e.firstChild)},contents:function(e){return e.contentDocument||fe.merge([],e.childNodes)}},function(e,t){fe.fn[e]=function(n,r){var i=fe.map(this,t,n);return"Until"!==e.slice(-5)&&(r=n),r&&"string"==typeof r&&(i=fe.filter(r,i)),this.length>1&&(Ee[e]||fe.uniqueSort(i),ke.test(e)&&i.reverse()),this.pushStack(i)}});var Se=/\S+/g;fe.Callbacks=function(e){e="string"==typeof e?a(e):fe.extend({},e);var t,n,r,i,o=[],s=[],u=-1,l=function(){for(i=e.once,r=t=!0;s.length;u=-1)for(n=s.shift();++u-1;)o.splice(n,1),n<=u&&u--}),this},has:function(e){return e?fe.inArray(e,o)>-1:o.length>0},empty:function(){return o&&(o=[]),this},disable:function(){return i=s=[],o=n="",this},disabled:function(){return!o},lock:function(){return i=s=[],n||t||(o=n=""),this},locked:function(){return!!i},fireWith:function(e,n){return i||(n=n||[],n=[e,n.slice?n.slice():n],s.push(n),t||l()),this},fire:function(){return c.fireWith(this,arguments),this},fired:function(){return!!r}};return c},fe.extend({Deferred:function(t){var n=[["notify","progress",fe.Callbacks("memory"),fe.Callbacks("memory"),2],["resolve","done",fe.Callbacks("once memory"),fe.Callbacks("once memory"),0,"resolved"],["reject","fail",fe.Callbacks("once memory"),fe.Callbacks("once memory"),1,"rejected"]],r="pending",i={state:function(){return r},always:function(){return o.done(arguments).fail(arguments),this},catch:function(e){return i.then(null,e)},pipe:function(){var e=arguments;return fe.Deferred(function(t){fe.each(n,function(n,r){var i=fe.isFunction(e[r[4]])&&e[r[4]];o[r[1]](function(){var e=i&&i.apply(this,arguments);e&&fe.isFunction(e.promise)?e.promise().progress(t.notify).done(t.resolve).fail(t.reject):t[r[0]+"With"](this,i?[e]:arguments)})}),e=null}).promise()},then:function(t,r,i){function o(t,n,r,i){return function(){var l=this,c=arguments,f=function(){var e,f;if(!(t=a&&(r!==u&&(l=void 0,c=[e]),n.rejectWith(l,c))}};t?p():(fe.Deferred.getStackHook&&(p.stackTrace=fe.Deferred.getStackHook()),e.setTimeout(p))}}var a=0;return fe.Deferred(function(e){n[0][3].add(o(0,e,fe.isFunction(i)?i:s,e.notifyWith)),n[1][3].add(o(0,e,fe.isFunction(t)?t:s)),n[2][3].add(o(0,e,fe.isFunction(r)?r:u))}).promise()},promise:function(e){return null!=e?fe.extend(e,i):i}},o={};return fe.each(n,function(e,t){var a=t[2],s=t[5];i[t[1]]=a.add,s&&a.add(function(){r=s},n[3-e][2].disable,n[0][2].lock),a.add(t[3].fire),o[t[0]]=function(){return o[t[0]+"With"](this===o?void 0:this,arguments),this},o[t[0]+"With"]=a.fireWith}),i.promise(o),t&&t.call(o,o),o},when:function(e){var t=arguments.length,n=t,r=Array(n),i=ee.call(arguments),o=fe.Deferred(),a=function(e){return function(n){r[e]=this,i[e]=arguments.length>1?ee.call(arguments):n,--t||o.resolveWith(r,i)}};if(t<=1&&(l(e,o.done(a(n)).resolve,o.reject),"pending"===o.state()||fe.isFunction(i[n]&&i[n].then)))return o.then();for(;n--;)l(i[n],a(n),o.reject);return o.promise()}});var Ne=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;fe.Deferred.exceptionHook=function(t,n){e.console&&e.console.warn&&t&&Ne.test(t.name)&&e.console.warn("jQuery.Deferred exception: "+t.message,t.stack,n)},fe.readyException=function(t){e.setTimeout(function(){throw t})};var De=fe.Deferred();fe.fn.ready=function(e){return De.then(e).catch(function(e){fe.readyException(e)}),this},fe.extend({isReady:!1,readyWait:1,holdReady:function(e){e?fe.readyWait++:fe.ready(!0)},ready:function(e){(!0===e?--fe.readyWait:fe.isReady)||(fe.isReady=!0,!0!==e&&--fe.readyWait>0||De.resolveWith(K,[fe]))}}),fe.ready.then=De.then,"complete"===K.readyState||"loading"!==K.readyState&&!K.documentElement.doScroll?e.setTimeout(fe.ready):(K.addEventListener("DOMContentLoaded",c),e.addEventListener("load",c));var je=function(e,t,n,r,i,o,a){var s=0,u=e.length,l=null==n;if("object"===fe.type(n)){i=!0;for(s in n)je(e,t,s,n[s],!0,o,a)}else if(void 0!==r&&(i=!0,fe.isFunction(r)||(a=!0),l&&(a?(t.call(e,r),t=null):(l=t,t=function(e,t,n){return l.call(fe(e),n)})),t))for(;s1,null,!0)},removeData:function(e){return this.each(function(){Le.remove(this,e)})}}),fe.extend({queue:function(e,t,n){var r;if(e)return t=(t||"fx")+"queue",r=qe.get(e,t),n&&(!r||fe.isArray(n)?r=qe.access(e,t,fe.makeArray(n)):r.push(n)),r||[]},dequeue:function(e,t){t=t||"fx";var n=fe.queue(e,t),r=n.length,i=n.shift(),o=fe._queueHooks(e,t);"inprogress"===i&&(i=n.shift(),r--),i&&("fx"===t&&n.unshift("inprogress"),delete o.stop,i.call(e,function(){fe.dequeue(e,t)},o)),!r&&o&&o.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return qe.get(e,n)||qe.access(e,n,{empty:fe.Callbacks("once memory").add(function(){qe.remove(e,[t+"queue",n])})})}}),fe.fn.extend({queue:function(e,t){var n=2;return"string"!=typeof e&&(t=e,e="fx",n--),arguments.length\x20\t\r\n\f]+)/i,_e=/^$|\/(?:java|ecma)script/i,ze={option:[1,""],thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};ze.optgroup=ze.option,ze.tbody=ze.tfoot=ze.colgroup=ze.caption=ze.thead,ze.th=ze.td;var Xe=/<|&#?\w+;/;!function(){var e=K.createDocumentFragment().appendChild(K.createElement("div")),t=K.createElement("input");t.setAttribute("type","radio"),t.setAttribute("checked","checked"),t.setAttribute("name","t"),e.appendChild(t),le.checkClone=e.cloneNode(!0).cloneNode(!0).lastChild.checked,e.innerHTML="",le.noCloneChecked=!!e.cloneNode(!0).lastChild.defaultValue}();var Ue=K.documentElement,Ve=/^key/,Ge=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ye=/^([^.]*)(?:\.(.+)|)/;fe.event={global:{},add:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,m=qe.get(e);if(m)for(n.handler&&(o=n,n=o.handler,i=o.selector),i&&fe.find.matchesSelector(Ue,i),n.guid||(n.guid=fe.guid++),(u=m.events)||(u=m.events={}),(a=m.handle)||(a=m.handle=function(t){return void 0!==fe&&fe.event.triggered!==t.type?fe.event.dispatch.apply(e,arguments):void 0}),l=(t=(t||"").match(Se)||[""]).length;l--;)s=Ye.exec(t[l])||[],d=g=s[1],h=(s[2]||"").split(".").sort(),d&&(f=fe.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=fe.event.special[d]||{},c=fe.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&fe.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||(p=u[d]=[],p.delegateCount=0,f.setup&&!1!==f.setup.call(e,r,h,a)||e.addEventListener&&e.addEventListener(d,a)),f.add&&(f.add.call(e,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),fe.event.global[d]=!0)},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,m=qe.hasData(e)&&qe.get(e);if(m&&(u=m.events)){for(l=(t=(t||"").match(Se)||[""]).length;l--;)if(s=Ye.exec(t[l])||[],d=g=s[1],h=(s[2]||"").split(".").sort(),d){for(f=fe.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;o--;)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,m.handle)||fe.removeEvent(e,d,m.handle),delete u[d])}else for(d in u)fe.event.remove(e,d+t[l],n,r,!0);fe.isEmptyObject(u)&&qe.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=fe.event.fix(e),u=new Array(arguments.length),l=(qe.get(this,"events")||{})[s.type]||[],c=fe.event.special[s.type]||{};for(u[0]=s,t=1;t-1:fe.find(i,this,null,[u]).length),r[i]&&r.push(o);r.length&&a.push({elem:u,handlers:r})}return s\x20\t\r\n\f]*)[^>]*)\/>/gi,Je=/\s*$/g;fe.extend({htmlPrefilter:function(e){return e.replace(Qe,"<$1>")},clone:function(e,t,n){var r,i,o,a,s=e.cloneNode(!0),u=fe.contains(e.ownerDocument,e);if(!(le.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||fe.isXMLDoc(e)))for(a=m(s),o=m(e),r=0,i=o.length;r0&&v(a,!u&&m(e,"script")),s},cleanData:function(e){for(var t,n,r,i=fe.event.special,o=0;void 0!==(n=e[o]);o++)if(Ae(n)){if(t=n[qe.expando]){if(t.events)for(r in t.events)i[r]?fe.event.remove(n,r):fe.removeEvent(n,r,t.handle);n[qe.expando]=void 0}n[Le.expando]&&(n[Le.expando]=void 0)}}}),fe.fn.extend({detach:function(e){return j(this,e,!0)},remove:function(e){return j(this,e)},text:function(e){return je(this,function(e){return void 0===e?fe.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=e)})},null,e,arguments.length)},append:function(){return D(this,arguments,function(e){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||C(this,e).appendChild(e)})},prepend:function(){return D(this,arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=C(this,e);t.insertBefore(e,t.firstChild)}})},before:function(){return D(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this)})},after:function(){return D(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this.nextSibling)})},empty:function(){for(var e,t=0;null!=(e=this[t]);t++)1===e.nodeType&&(fe.cleanData(m(e,!1)),e.textContent="");return this},clone:function(e,t){return e=null!=e&&e,t=null==t?e:t,this.map(function(){return fe.clone(this,e,t)})},html:function(e){return je(this,function(e){var t=this[0]||{},n=0,r=this.length;if(void 0===e&&1===t.nodeType)return t.innerHTML;if("string"==typeof e&&!Je.test(e)&&!ze[(Be.exec(e)||["",""])[1].toLowerCase()]){e=fe.htmlPrefilter(e);try{for(;n1)}}),fe.Tween=P,P.prototype={constructor:P,init:function(e,t,n,r,i,o){this.elem=e,this.prop=n,this.easing=i||fe.easing._default,this.options=t,this.start=this.now=this.cur(),this.end=r,this.unit=o||(fe.cssNumber[n]?"":"px")},cur:function(){var e=P.propHooks[this.prop];return e&&e.get?e.get(this):P.propHooks._default.get(this)},run:function(e){var t,n=P.propHooks[this.prop];return this.options.duration?this.pos=t=fe.easing[this.easing](e,this.options.duration*e,0,1,this.options.duration):this.pos=t=e,this.now=(this.end-this.start)*t+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),n&&n.set?n.set(this):P.propHooks._default.set(this),this}},P.prototype.init.prototype=P.prototype,P.propHooks={_default:{get:function(e){var t;return 1!==e.elem.nodeType||null!=e.elem[e.prop]&&null==e.elem.style[e.prop]?e.elem[e.prop]:(t=fe.css(e.elem,e.prop,""))&&"auto"!==t?t:0},set:function(e){fe.fx.step[e.prop]?fe.fx.step[e.prop](e):1!==e.elem.nodeType||null==e.elem.style[fe.cssProps[e.prop]]&&!fe.cssHooks[e.prop]?e.elem[e.prop]=e.now:fe.style(e.elem,e.prop,e.now+e.unit)}}},P.propHooks.scrollTop=P.propHooks.scrollLeft={set:function(e){e.elem.nodeType&&e.elem.parentNode&&(e.elem[e.prop]=e.now)}},fe.easing={linear:function(e){return e},swing:function(e){return.5-Math.cos(e*Math.PI)/2},_default:"swing"},fe.fx=P.prototype.init,fe.fx.step={};var lt,ct,ft=/^(?:toggle|show|hide)$/,pt=/queueHooks$/;fe.Animation=fe.extend(B,{tweeners:{"*":[function(e,t){var n=this.createTween(e,t);return d(n.elem,e,Pe.exec(t),n),n}]},tweener:function(e,t){fe.isFunction(e)?(t=e,e=["*"]):e=e.match(Se);for(var n,r=0,i=e.length;r1)},removeAttr:function(e){return this.each(function(){fe.removeAttr(this,e)})}}),fe.extend({attr:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return void 0===e.getAttribute?fe.prop(e,t,n):(1===o&&fe.isXMLDoc(e)||(i=fe.attrHooks[t.toLowerCase()]||(fe.expr.match.bool.test(t)?dt:void 0)),void 0!==n?null===n?void fe.removeAttr(e,t):i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:(e.setAttribute(t,n+""),n):i&&"get"in i&&null!==(r=i.get(e,t))?r:null==(r=fe.find.attr(e,t))?void 0:r)},attrHooks:{type:{set:function(e,t){if(!le.radioValue&&"radio"===t&&fe.nodeName(e,"input")){var n=e.value;return e.setAttribute("type",t),n&&(e.value=n),t}}}},removeAttr:function(e,t){var n,r=0,i=t&&t.match(Se);if(i&&1===e.nodeType)for(;n=i[r++];)e.removeAttribute(n)}}),dt={set:function(e,t,n){return!1===t?fe.removeAttr(e,n):e.setAttribute(n,n),n}},fe.each(fe.expr.match.bool.source.match(/\w+/g),function(e,t){var n=ht[t]||fe.find.attr;ht[t]=function(e,t,r){var i,o,a=t.toLowerCase();return r||(o=ht[a],ht[a]=i,i=null!=n(e,t,r)?a:null,ht[a]=o),i}});var gt=/^(?:input|select|textarea|button)$/i,mt=/^(?:a|area)$/i;fe.fn.extend({prop:function(e,t){return je(this,fe.prop,e,t,arguments.length>1)},removeProp:function(e){return this.each(function(){delete this[fe.propFix[e]||e]})}}),fe.extend({prop:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return 1===o&&fe.isXMLDoc(e)||(t=fe.propFix[t]||t,i=fe.propHooks[t]),void 0!==n?i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:e[t]=n:i&&"get"in i&&null!==(r=i.get(e,t))?r:e[t]},propHooks:{tabIndex:{get:function(e){var t=fe.find.attr(e,"tabindex");return t?parseInt(t,10):gt.test(e.nodeName)||mt.test(e.nodeName)&&e.href?0:-1}}},propFix:{for:"htmlFor",class:"className"}}),le.optSelected||(fe.propHooks.selected={get:function(e){var t=e.parentNode;return t&&t.parentNode&&t.parentNode.selectedIndex,null},set:function(e){var t=e.parentNode;t&&(t.selectedIndex,t.parentNode&&t.parentNode.selectedIndex)}}),fe.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){fe.propFix[this.toLowerCase()]=this});var vt=/[\t\r\n\f]/g;fe.fn.extend({addClass:function(e){var t,n,r,i,o,a,s,u=0;if(fe.isFunction(e))return this.each(function(t){fe(this).addClass(e.call(this,t,_(this)))});if("string"==typeof e&&e)for(t=e.match(Se)||[];n=this[u++];)if(i=_(n),r=1===n.nodeType&&(" "+i+" ").replace(vt," ")){for(a=0;o=t[a++];)r.indexOf(" "+o+" ")<0&&(r+=o+" ");i!==(s=fe.trim(r))&&n.setAttribute("class",s)}return this},removeClass:function(e){var t,n,r,i,o,a,s,u=0;if(fe.isFunction(e))return this.each(function(t){fe(this).removeClass(e.call(this,t,_(this)))});if(!arguments.length)return this.attr("class","");if("string"==typeof e&&e)for(t=e.match(Se)||[];n=this[u++];)if(i=_(n),r=1===n.nodeType&&(" "+i+" ").replace(vt," ")){for(a=0;o=t[a++];)for(;r.indexOf(" "+o+" ")>-1;)r=r.replace(" "+o+" "," ");i!==(s=fe.trim(r))&&n.setAttribute("class",s)}return this},toggleClass:function(e,t){var n=typeof e;return"boolean"==typeof t&&"string"===n?t?this.addClass(e):this.removeClass(e):fe.isFunction(e)?this.each(function(n){fe(this).toggleClass(e.call(this,n,_(this),t),t)}):this.each(function(){var t,r,i,o;if("string"===n)for(r=0,i=fe(this),o=e.match(Se)||[];t=o[r++];)i.hasClass(t)?i.removeClass(t):i.addClass(t);else void 0!==e&&"boolean"!==n||((t=_(this))&&qe.set(this,"__className__",t),this.setAttribute&&this.setAttribute("class",t||!1===e?"":qe.get(this,"__className__")||""))})},hasClass:function(e){var t,n,r=0;for(t=" "+e+" ";n=this[r++];)if(1===n.nodeType&&(" "+_(n)+" ").replace(vt," ").indexOf(t)>-1)return!0;return!1}});var yt=/\r/g,xt=/[\x20\t\r\n\f]+/g;fe.fn.extend({val:function(e){var t,n,r,i=this[0];return arguments.length?(r=fe.isFunction(e),this.each(function(n){var i;1===this.nodeType&&(null==(i=r?e.call(this,n,fe(this).val()):e)?i="":"number"==typeof i?i+="":fe.isArray(i)&&(i=fe.map(i,function(e){return null==e?"":e+""})),(t=fe.valHooks[this.type]||fe.valHooks[this.nodeName.toLowerCase()])&&"set"in t&&void 0!==t.set(this,i,"value")||(this.value=i))})):i?(t=fe.valHooks[i.type]||fe.valHooks[i.nodeName.toLowerCase()])&&"get"in t&&void 0!==(n=t.get(i,"value"))?n:"string"==typeof(n=i.value)?n.replace(yt,""):null==n?"":n:void 0}}),fe.extend({valHooks:{option:{get:function(e){var t=fe.find.attr(e,"value");return null!=t?t:fe.trim(fe.text(e)).replace(xt," ")}},select:{get:function(e){for(var t,n,r=e.options,i=e.selectedIndex,o="select-one"===e.type,a=o?null:[],s=o?i+1:r.length,u=i<0?s:o?i:0;u-1)&&(n=!0);return n||(e.selectedIndex=-1),o}}}}),fe.each(["radio","checkbox"],function(){fe.valHooks[this]={set:function(e,t){if(fe.isArray(t))return e.checked=fe.inArray(fe(e).val(),t)>-1}},le.checkOn||(fe.valHooks[this].get=function(e){return null===e.getAttribute("value")?"on":e.value})});var bt=/^(?:focusinfocus|focusoutblur)$/;fe.extend(fe.event,{trigger:function(t,n,r,i){var o,a,s,u,l,c,f,p=[r||K],d=ae.call(t,"type")?t.type:t,h=ae.call(t,"namespace")?t.namespace.split("."):[];if(a=s=r=r||K,3!==r.nodeType&&8!==r.nodeType&&!bt.test(d+fe.event.triggered)&&(d.indexOf(".")>-1&&(h=d.split("."),d=h.shift(),h.sort()),l=d.indexOf(":")<0&&"on"+d,t=t[fe.expando]?t:new fe.Event(d,"object"==typeof t&&t),t.isTrigger=i?2:3,t.namespace=h.join("."),t.rnamespace=t.namespace?new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,t.result=void 0,t.target||(t.target=r),n=null==n?[t]:fe.makeArray(n,[t]),f=fe.event.special[d]||{},i||!f.trigger||!1!==f.trigger.apply(r,n))){if(!i&&!f.noBubble&&!fe.isWindow(r)){for(u=f.delegateType||d,bt.test(u+d)||(a=a.parentNode);a;a=a.parentNode)p.push(a),s=a;s===(r.ownerDocument||K)&&p.push(s.defaultView||s.parentWindow||e)}for(o=0;(a=p[o++])&&!t.isPropagationStopped();)t.type=o>1?u:f.bindType||d,(c=(qe.get(a,"events")||{})[t.type]&&qe.get(a,"handle"))&&c.apply(a,n),(c=l&&a[l])&&c.apply&&Ae(a)&&(t.result=c.apply(a,n),!1===t.result&&t.preventDefault());return t.type=d,i||t.isDefaultPrevented()||f._default&&!1!==f._default.apply(p.pop(),n)||!Ae(r)||l&&fe.isFunction(r[d])&&!fe.isWindow(r)&&((s=r[l])&&(r[l]=null),fe.event.triggered=d,r[d](),fe.event.triggered=void 0,s&&(r[l]=s)),t.result}},simulate:function(e,t,n){var r=fe.extend(new fe.Event,n,{type:e,isSimulated:!0});fe.event.trigger(r,null,t)}}),fe.fn.extend({trigger:function(e,t){return this.each(function(){fe.event.trigger(e,t,this)})},triggerHandler:function(e,t){var n=this[0];if(n)return fe.event.trigger(e,t,n,!0)}}),fe.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,t){fe.fn[t]=function(e,n){return arguments.length>0?this.on(t,null,e,n):this.trigger(t)}}),fe.fn.extend({hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),le.focusin="onfocusin"in e,le.focusin||fe.each({focus:"focusin",blur:"focusout"},function(e,t){var n=function(e){fe.event.simulate(t,e.target,fe.event.fix(e))};fe.event.special[t]={setup:function(){var r=this.ownerDocument||this,i=qe.access(r,t);i||r.addEventListener(e,n,!0),qe.access(r,t,(i||0)+1)},teardown:function(){var r=this.ownerDocument||this,i=qe.access(r,t)-1;i?qe.access(r,t,i):(r.removeEventListener(e,n,!0),qe.remove(r,t))}}});var wt=e.location,Tt=fe.now(),Ct=/\?/;fe.parseXML=function(t){var n;if(!t||"string"!=typeof t)return null;try{n=(new e.DOMParser).parseFromString(t,"text/xml")}catch(e){n=void 0}return n&&!n.getElementsByTagName("parsererror").length||fe.error("Invalid XML: "+t),n};var kt=/\[\]$/,Et=/\r?\n/g,St=/^(?:submit|button|image|reset|file)$/i,Nt=/^(?:input|select|textarea|keygen)/i;fe.param=function(e,t){var n,r=[],i=function(e,t){var n=fe.isFunction(t)?t():t;r[r.length]=encodeURIComponent(e)+"="+encodeURIComponent(null==n?"":n)};if(fe.isArray(e)||e.jquery&&!fe.isPlainObject(e))fe.each(e,function(){i(this.name,this.value)});else for(n in e)z(n,e[n],t,i);return r.join("&")},fe.fn.extend({serialize:function(){return fe.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var e=fe.prop(this,"elements");return e?fe.makeArray(e):this}).filter(function(){var e=this.type;return this.name&&!fe(this).is(":disabled")&&Nt.test(this.nodeName)&&!St.test(e)&&(this.checked||!$e.test(e))}).map(function(e,t){var n=fe(this).val();return null==n?null:fe.isArray(n)?fe.map(n,function(e){return{name:t.name,value:e.replace(Et,"\r\n")}}):{name:t.name,value:n.replace(Et,"\r\n")}}).get()}});var Dt=/%20/g,jt=/#.*$/,At=/([?&])_=[^&]*/,qt=/^(.*?):[ \t]*([^\r\n]*)$/gm,Lt=/^(?:GET|HEAD)$/,Ht=/^\/\//,Ft={},Ot={},Pt="*/".concat("*"),Rt=K.createElement("a");Rt.href=wt.href,fe.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:wt.href,type:"GET",isLocal:/^(?:about|app|app-storage|.+-extension|file|res|widget):$/.test(wt.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":Pt,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":fe.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(e,t){return t?V(V(e,fe.ajaxSettings),t):V(fe.ajaxSettings,e)},ajaxPrefilter:X(Ft),ajaxTransport:X(Ot),ajax:function(t,n){function r(t,n,r,s){var l,p,d,b,w,T=n;c||(c=!0,u&&e.clearTimeout(u),i=void 0,a=s||"",C.readyState=t>0?4:0,l=t>=200&&t<300||304===t,r&&(b=G(h,C,r)),b=Y(h,b,C,l),l?(h.ifModified&&((w=C.getResponseHeader("Last-Modified"))&&(fe.lastModified[o]=w),(w=C.getResponseHeader("etag"))&&(fe.etag[o]=w)),204===t||"HEAD"===h.type?T="nocontent":304===t?T="notmodified":(T=b.state,p=b.data,d=b.error,l=!d)):(d=T,!t&&T||(T="error",t<0&&(t=0))),C.status=t,C.statusText=(n||T)+"",l?v.resolveWith(g,[p,T,C]):v.rejectWith(g,[C,T,d]),C.statusCode(x),x=void 0,f&&m.trigger(l?"ajaxSuccess":"ajaxError",[C,h,l?p:d]),y.fireWith(g,[C,T]),f&&(m.trigger("ajaxComplete",[C,h]),--fe.active||fe.event.trigger("ajaxStop")))}"object"==typeof t&&(n=t,t=void 0),n=n||{};var i,o,a,s,u,l,c,f,p,d,h=fe.ajaxSetup({},n),g=h.context||h,m=h.context&&(g.nodeType||g.jquery)?fe(g):fe.event,v=fe.Deferred(),y=fe.Callbacks("once memory"),x=h.statusCode||{},b={},w={},T="canceled",C={readyState:0,getResponseHeader:function(e){var t;if(c){if(!s)for(s={};t=qt.exec(a);)s[t[1].toLowerCase()]=t[2];t=s[e.toLowerCase()]}return null==t?null:t},getAllResponseHeaders:function(){return c?a:null},setRequestHeader:function(e,t){return null==c&&(e=w[e.toLowerCase()]=w[e.toLowerCase()]||e,b[e]=t),this},overrideMimeType:function(e){return null==c&&(h.mimeType=e),this},statusCode:function(e){var t;if(e)if(c)C.always(e[C.status]);else for(t in e)x[t]=[x[t],e[t]];return this},abort:function(e){var t=e||T;return i&&i.abort(t),r(0,t),this}};if(v.promise(C),h.url=((t||h.url||wt.href)+"").replace(Ht,wt.protocol+"//"),h.type=n.method||n.type||h.method||h.type,h.dataTypes=(h.dataType||"*").toLowerCase().match(Se)||[""],null==h.crossDomain){l=K.createElement("a");try{l.href=h.url,l.href=l.href,h.crossDomain=Rt.protocol+"//"+Rt.host!=l.protocol+"//"+l.host}catch(e){h.crossDomain=!0}}if(h.data&&h.processData&&"string"!=typeof h.data&&(h.data=fe.param(h.data,h.traditional)),U(Ft,h,n,C),c)return C;(f=fe.event&&h.global)&&0==fe.active++&&fe.event.trigger("ajaxStart"),h.type=h.type.toUpperCase(),h.hasContent=!Lt.test(h.type),o=h.url.replace(jt,""),h.hasContent?h.data&&h.processData&&0===(h.contentType||"").indexOf("application/x-www-form-urlencoded")&&(h.data=h.data.replace(Dt,"+")):(d=h.url.slice(o.length),h.data&&(o+=(Ct.test(o)?"&":"?")+h.data,delete h.data),!1===h.cache&&(o=o.replace(At,""),d=(Ct.test(o)?"&":"?")+"_="+Tt+++d),h.url=o+d),h.ifModified&&(fe.lastModified[o]&&C.setRequestHeader("If-Modified-Since",fe.lastModified[o]),fe.etag[o]&&C.setRequestHeader("If-None-Match",fe.etag[o])),(h.data&&h.hasContent&&!1!==h.contentType||n.contentType)&&C.setRequestHeader("Content-Type",h.contentType),C.setRequestHeader("Accept",h.dataTypes[0]&&h.accepts[h.dataTypes[0]]?h.accepts[h.dataTypes[0]]+("*"!==h.dataTypes[0]?", "+Pt+"; q=0.01":""):h.accepts["*"]);for(p in h.headers)C.setRequestHeader(p,h.headers[p]);if(h.beforeSend&&(!1===h.beforeSend.call(g,C,h)||c))return C.abort();if(T="abort",y.add(h.complete),C.done(h.success),C.fail(h.error),i=U(Ot,h,n,C)){if(C.readyState=1,f&&m.trigger("ajaxSend",[C,h]),c)return C;h.async&&h.timeout>0&&(u=e.setTimeout(function(){C.abort("timeout")},h.timeout));try{c=!1,i.send(b,r)}catch(e){if(c)throw e;r(-1,e)}}else r(-1,"No Transport");return C},getJSON:function(e,t,n){return fe.get(e,t,n,"json")},getScript:function(e,t){return fe.get(e,void 0,t,"script")}}),fe.each(["get","post"],function(e,t){fe[t]=function(e,n,r,i){return fe.isFunction(n)&&(i=i||r,r=n,n=void 0),fe.ajax(fe.extend({url:e,type:t,dataType:i,data:n,success:r},fe.isPlainObject(e)&&e))}}),fe._evalUrl=function(e){return fe.ajax({url:e,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,throws:!0})},fe.fn.extend({wrapAll:function(e){var t;return this[0]&&(fe.isFunction(e)&&(e=e.call(this[0])),t=fe(e,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){for(var e=this;e.firstElementChild;)e=e.firstElementChild;return e}).append(this)),this},wrapInner:function(e){return fe.isFunction(e)?this.each(function(t){fe(this).wrapInner(e.call(this,t))}):this.each(function(){var t=fe(this),n=t.contents();n.length?n.wrapAll(e):t.append(e)})},wrap:function(e){var t=fe.isFunction(e);return this.each(function(n){fe(this).wrapAll(t?e.call(this,n):e)})},unwrap:function(e){return this.parent(e).not("body").each(function(){fe(this).replaceWith(this.childNodes)}),this}}),fe.expr.pseudos.hidden=function(e){return!fe.expr.pseudos.visible(e)},fe.expr.pseudos.visible=function(e){return!!(e.offsetWidth||e.offsetHeight||e.getClientRects().length)},fe.ajaxSettings.xhr=function(){try{return new e.XMLHttpRequest}catch(e){}};var Mt={0:200,1223:204},It=fe.ajaxSettings.xhr();le.cors=!!It&&"withCredentials"in It,le.ajax=It=!!It,fe.ajaxTransport(function(t){var n,r;if(le.cors||It&&!t.crossDomain)return{send:function(i,o){var a,s=t.xhr();if(s.open(t.type,t.url,t.async,t.username,t.password),t.xhrFields)for(a in t.xhrFields)s[a]=t.xhrFields[a];t.mimeType&&s.overrideMimeType&&s.overrideMimeType(t.mimeType),t.crossDomain||i["X-Requested-With"]||(i["X-Requested-With"]="XMLHttpRequest");for(a in i)s.setRequestHeader(a,i[a]);n=function(e){return function(){n&&(n=r=s.onload=s.onerror=s.onabort=s.onreadystatechange=null,"abort"===e?s.abort():"error"===e?"number"!=typeof s.status?o(0,"error"):o(s.status,s.statusText):o(Mt[s.status]||s.status,s.statusText,"text"!==(s.responseType||"text")||"string"!=typeof s.responseText?{binary:s.response}:{text:s.responseText},s.getAllResponseHeaders()))}},s.onload=n(),r=s.onerror=n("error"),void 0!==s.onabort?s.onabort=r:s.onreadystatechange=function(){4===s.readyState&&e.setTimeout(function(){n&&r()})},n=n("abort");try{s.send(t.hasContent&&t.data||null)}catch(e){if(n)throw e}},abort:function(){n&&n()}}}),fe.ajaxPrefilter(function(e){e.crossDomain&&(e.contents.script=!1)}),fe.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(e){return fe.globalEval(e),e}}}),fe.ajaxPrefilter("script",function(e){void 0===e.cache&&(e.cache=!1),e.crossDomain&&(e.type="GET")}),fe.ajaxTransport("script",function(e){if(e.crossDomain){var t,n;return{send:function(r,i){t=fe(" - - - - - - - - - - - - - - - - -
-
-
-
- -
-

Installing PyAMS

-

PyAMS default installation is based on Buildout utility. It’s not mandatory to use a -virtual environment, but it allows you to have a better control over your Python resources.

-

Current PyAMS version is based and validated for Python 3.5; your Python environment must also include a C -compiler as well as development headers for Python, libjpeg, libpng, libfreetype, libxml2, libxslt and -eventually libldap, libffi, libgdal or libzmq.

-

PyAMS default components configuration also pre-suppose that the following external tools are available:

-
    -
  • a Memcached or Redis server, to store sessions and cache (can be changed through Beaker configuration)
    • -
-

Optional tools also include:

-
    -
  • an LDAP server for authentication
    • -
  • an ElasticSearch server for full text indexing (see PyAMS_content_es package)
    • -
  • a WebSockets server using AsyncIO. This is used to manage notifications (see PyAMS_notify and PyAMS_notify_ws -packages). An out of the box environment can be built using pyams_notify scaffold.
    • -
-

PyAMS also needs that you use a ZODB remote server, as several background processes needing a concurrent access to ZODB -are started by PyAMS main process. Three ZODB storages are already provided through PyAMS: ZEO, RelStorage or Newt.db. -See Creating ZODB to know how to initialize database with the help of PyAMS tools.

-
-

Creating initial buildout

-

PyAMS provides a new Pyramid scaffold, called pyams, generated via a cookiecutter template.

-

A simple option to install PyAMS is to create a buildout environment including Pyramid and all PyAMS packages:

-
# mkdir /var/local/
-# pip3 install virtualenv
-# virtualenv --python=python3.5 env
-# cd env
-# . bin/activate
-(env) # pip3.5 install cookiecutter
-(env) # cookiecutter hg+http://hg.ztfy.org/pyams/scaffolds/pyams
-
-
-

CookieCutter will ask you for a small set of input variables that you can change or not:

-
    -
  • pyams_release: version of PyAMS configuration file to use. “latest” (default value) will point to last release; -you can also choose to point to a given release (“0.1.4” for example)
    • -
  • project_name: current environment name in “human form”
    • -
  • project_slug: “technical” package name, based on project name
    • -
  • virtual_hostname: Apache virtual-host name
    • -
  • webapp_name: web application package name (“webapp” as default)
    • -
  • webapp_port: TCP/IP port to use when running application outside Apache (“6543” as default)
    • -
  • eggs_directory: relative or absolute path to directory containing downloaded eggs; this directory can be -shared with other projects (“eggs” as default)
    • -
  • logs_directory: absolute path to directory containing Apache’s log files
    • -
  • run_user: user name under which Apache process will run (“www-data” as default)
    • -
  • run_group: group name under which Apache process will run (“www-data” as default)
    • -
  • beaker_backend: name of Beaker backend to use to store sessions and cache data (“redis” as default)
    • -
  • beaker_server: IP address and port of Beaker backend server (“127.0.0.1:6379” as default)
    • -
  • db_type: ZODB database storage; available options include ZEO, RelStorage and NewtDB
    • -
  • db_host: IP address of database server (“127.0.0.1” as default); WARNING: database server installation -is not part of application installation; another “zeo_server” cookiecutter recipe is available for ZEO
    • -
  • db_port: listening port of database server (“8100” is given as default for ZEO)
    • -
  • db_name: database or ZEO storage name to use
    • -
  • db_username: database user name
    • -
  • db_password: database password
    • -
  • zeo_realm: ZEO authentication realm
    • -
  • blobs_dir: local directory to use to store cache of ZODB blobs; cache size is limited to 10GB as default
    • -
  • use_postgresql: specify if PostgreSQL access is required; if so, please check that PostgreSQL development files -are available to compile PsycoPG2 extension
    • -
  • use_oracle: specify if Oracle access is required; if so, please check that Oracle development files are -available to compile cx_Oracle extension, and that ORACLE_HOME environment variable is correctly defined (see below)
    • -
  • use_ldap: specify if LDAP access will be required for authentication
    • -
  • use_elasticsearch: specify if an ElasticSearch server will be used for indexation
    • -
  • elasticsearch_server: URL used to access Elasticsearch server (“http://127.0.0.1:9200” as default); this URL can -include login and password (“http://login:password@127.0.0.1:9200”), if required…
    • -
  • elasticsearch_index: name of Elasticsearch index to use (“pyams” as default)
    • -
  • create_elasticsearch_index: specify if Elasticsearch index should be created after installation is complete
    • -
  • define_elasticsearch_mappings : specify if Elasticsearch mappings should be defined after installation is complete
    • -
  • smtp_server: DNS name of SMTP server (“localhost” as default)
    • -
  • smtp_server_name: “human” name given to SMTP server (“pyams” as default)
    • -
  • pyams_scheduler: TCP/IP address and port to use to access PyAMS tasks scheduler process (“127.0.0.1:5555” as -default); see pyams_scheduler
    • -
  • start_scheduler: boolean value to indicate if scheduler process is started by this application instance
    • -
  • pyams_medias_converter: TCP/IP address and port to use to access PyAMS medias converter process (“127.0.0.1:5556” -as default); see pyams_medias
    • -
  • start_medias_converter: boolean value to indicate if medias converter process is started by this application -instance
    • -
  • pyams_es_indexer: TCP/IP address and port to use to access PyAMS Elasticsearch indexer process (“127.0.0.1:5557” -as default); see pyams_content_es
    • -
  • start_es_indexer boolean value to indicate if Elasticsearch indexer process is started by this application -instance
    • -
  • use_notifications: specify if PyAMS notifications services are to be used (see PyAMS notification services)
    • -
  • pyams_ws_notify: TCP/IP address and port of PyAMS websockets server managing notifications service -(“127.0.0.1:8081” as default)
    • -
  • lexicon_languages: NLTK lexicon languages to use (“en:english fr:french” as default)
    • -
  • extension_package: name of a PyAMS extension package to include in environment configuration
    • -
  • need_pyams_gis: specify if PyAMS GIS features are to be used by given extension package; if so, please check -that libgdal development files are available; on Debian (and maybe others), you have to specify environment -variables (see below).
    • -
-

You can then check, and eventually update, the proposed Buildout configuration file buildout.cfg, to add or remove -packages or update settings to your needs. Then finalize Bootstrap initialization:

-
(env) # python3.5 bootstrap.py
-(env) # ./bin/buildout
-
-
-

This last operation can be quite long, as many packages have to downloaded, compiled and installed in the virtual -environment. If you encounter any compile error, just install the required dependencies and restart the buildout.

-

Some dependencies can require the definition of custom environment variables before running buildout, like:

-
    -
  • for libgdal, which is required by PyAMS_gis package, use:
    • -
-
(env) # export C_INCLUDE_PATH=/usr/include/gdal
-(env) # export CPLUS_INCLUDE_PATH=/usr/include/gdal
-
-
-

WARNING: you have to check also that your libgdal release is matching “GDAL” release given in PyAMS -configuration file (actually 2.1.0).

-
    -
  • for cx_Oracle, which is required if you use Oracle database connections, use:
    • -
-
(env) # export ORACLE_HOME=/usr/lib/oracle/12.1/client64
-
-
-

These examples are given for Debian GNU/Linux. You may have to adapt configuration based on your own Linux -distribution and packages versions.

-
-
-

Environment settings

-

The project generated from pyams scaffold is based on default Pyramid’s zodb scaffold, but it adds:

-
    -
  • a custom application factory, in the webapp directory (see PyAMS site management)
    • -
  • a set of directories to store runtime data, in the var directory; each directory contains a README.txt file -which should be self-explanatory to indicate what this directory should contain, including a ZEO cache
    • -
  • a set of configuration files, in the etc directory; here are standard development.ini and production.ini -configuration files, a ZODB configuration files (zodb-zeo.conf) for a ZEO client storage and two Apache -configurations (for Apache 2.2 and 2.4) using mod_wsgi.
    • -
-

Once the project have been created from the scaffold, you are free to update all the configuration files.

-

If you need to add packages to the environment, you have to add them to the buildout.cfg file AND to the INI -file (in the pyramid.includes section) before running the buildout another time; don’t forget to add the -requested version at the end of buildout.cfg file, as Buildout is not configured by default to automatically -download the last release of a given unknown package.

-

development.ini and production.ini files contain many commented directives related to PyAMS components. Read and -update them carefully before initializing your application database!

-
-
-

Initializing the database

-

When you have downloaded and installed all required packages, you have to initialize the database so that all -required components are available.

-

From a shell, just type:

-
(env) # ./bin/pyams_upgrade etc/development.ini
-
-
-

This process requires that every package is correctly included into pyramid.includes directive from selected -configuration file.

-
-
-

Initializing Elasticsearch index

-

If you want to use an Elasticsearch index, you have to initialize index settings and mappings; the Ingest attachment -plug-in is also required to handle attachments correctly.

-

Elasticsearch integration is defined through the PyAMS_content_es package. Configuration files are available in this -package, for attachment pipeline, index settings and mappings:

-
(env) # cd /var/local/src/pyams/pyams_content_es
-(env) # curl --noproxy localhost -XDELETE http://localhost:9200/pyams (1)
-(env) # curl --noproxy localhost -XPUT    http://localhost:9200/pyams -d @index-settings.json
-
-(env) # curl --noproxy localhost -XPUT    http://localhost:9200/pyams/WfNewsEvent/_mapping -d @mappings/WfNewsEvent.json
-(env) # curl --noproxy localhost -XPUT    http://localhost:9200/pyams/WfTopic/_mapping -d @mappings/WfTopic.json
-(env) # curl --noproxy localhost -XPUT    http://localhost:9200/pyams/WfBlogPost/_mapping -d @mappings/WfBlogPost.json
-
-
-
    -
  1. If ‘pyams’ is defined as Elasticsearch index name.
    2. -
-
-
-

NLTK initialization

-

Some NLTK (Natural Language Toolkit) tokenizers and stopwords utilities are used to index fulltext contents elements. -This package requires downloading and configuration of several elements which are done as follow:

-
(end) # ./bin/py
->>> import nltk
->>> nltk.download()
-NLTK Downloader
----------------------------------------------------------------------------
-    d) Download   l) List    u) Update   c) Config   h) Help   q) Quit
----------------------------------------------------------------------------
-Downloader> c
-
-Data Server:
-  - URL: <https://raw.githubusercontent.com/nltk/nltk_data/gh-pages/index.xml>
-  - 6 Package Collections Available
-  - 107 Individual Packages Available
-
-Local Machine:
-  - Data directory: /home/tflorac/nltk_data
-
----------------------------------------------------------------------------
-    s) Show Config   u) Set Server URL   d) Set Data Dir   m) Main Menu
----------------------------------------------------------------------------
-Config> d
-  New directory> /usr/local/lib/nltk_data (1)
-Config> m
-
----------------------------------------------------------------------------
-    d) Download   l) List    u) Update   c) Config   h) Help   q) Quit
----------------------------------------------------------------------------
-Downloader> d
-
-Download which package (l=list; x=cancel)?
-  Identifier> punkt
-    Downloading package punkt to /usr/local/lib/nltk_data...
-
-Downloader> d
-
-Download which package (l=list; x=cancel)?
-  Identifier> stopwords
-    Downloading package stopwords to /usr/local/lib/nltk_data...
-
-
-

(1) On Debian GNU/Linux, you can choose any directory between ‘~/nltk_data’ (where ‘~’ is the homedir of user running -Pyramid application), ‘/usr/share/nltk_data’, ‘/usr/local/share/nltk_data’, ‘/usr/lib/nltk_data’ and -‘/usr/local/lib/nltk_data’.

-
-
-

Starting the application

-

When database upgrade process has ended, you can start the web application process with the standard Pyramid’s -pserve command line tool:

-
(env) # ./bin/pserve etc/development.ini
-
-
-

In standard debug mode, all registered components are displayed in the console, until the final line (here using ZEO):

-
2018-01-14 11:37:54,339 INFO  [ZEO.ClientStorage][MainThread] [('127.0.0.1', 8100)] ClientStorage (pid=28695) created RW/normal for storage: 'pyams'
-2018-01-14 11:37:54,340 INFO  [ZEO.cache][MainThread] created temporary cache file 3
-2018-01-14 11:37:54,345 INFO  [ZODB.blob][MainThread] (28695) Blob directory `/var/local/env/pyams/var/db/blobs` is used but has no layout marker set. Selected `lawn` layout.
-2018-01-14 11:37:54,345 WARNI [ZODB.blob][MainThread] (28695) The `lawn` blob directory layout is deprecated due to scalability issues on some file systems, please consider migrating to the `bushy` layout.
-2018-01-14 11:37:54,346 DEBUG [asyncio][[('127.0.0.1', 8100)] zeo client networking thread] Using selector: EpollSelector
-2018-01-14 11:37:54,347 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] disconnected <ZEO.asyncio.client.Client object at 0x7feeb1de7390> None
-2018-01-14 11:37:54,348 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] try_connecting
-2018-01-14 11:37:54,349 INFO  [ZEO.asyncio.base][[('127.0.0.1', 8100)] zeo client networking thread] Connected Protocol(('127.0.0.1', 8100), 'pyams', False)
-2018-01-14 11:37:54,355 INFO  [ZEO.ClientStorage][[('127.0.0.1', 8100)] zeo client networking thread] [('127.0.0.1', 8100)] Connected to storage: ('localhost', 8100)
-2018-01-14 11:37:54,358 DEBUG [txn.140663320073984][MainThread] new transaction
-2018-01-14 11:37:54,360 DEBUG [txn.140663320073984][MainThread] commit
-2018-01-14 11:37:54,484 DEBUG [config][MainThread] include /home/tflorac/Dropbox/src/PyAMS/pyams_template/src/pyams_template/configure.zcml
-2018-01-14 11:37:54,485 DEBUG [config][MainThread] include /var/local/env/pycharm/lib/python3.5/site-packages/pyramid_zcml/configure.zcml
-...
-2018-01-14 11:37:54,833 DEBUG [PyAMS (utils)][MainThread] Registering utility <class 'pyams_utils.timezone.utility.TimezoneGenerationsChecker'> named 'PyAMS timezone' providing <InterfaceClass pyams_utils.interfaces.site.ISiteGenerations>
-2018-01-14 11:37:54,834 DEBUG [PyAMS (utils)][MainThread] Registering class <class 'pyams_utils.timezone.vocabulary.TimezonesVocabulary'> as vocabulary with name "PyAMS timezones"
-2018-01-14 11:37:54,835 DEBUG [PyAMS (utils)][MainThread] Registering adapter <class 'pyams_utils.traversing.PathElementsAdapter'> for (<InterfaceClass zope.location.interfaces.IContained>,) providing <InterfaceClass pyams_utils.interfaces.traversing.IPathElements>
-2018-01-14 11:37:54,839 DEBUG [PyAMS (utils)][MainThread] Registering adapter <class 'pyams_utils.url.AbsoluteUrlTalesExtension'> for (<InterfaceClass zope.interface.Interface>, <InterfaceClass zope.interface.Interface>, <InterfaceClass zope.interface.Interface>) providing <InterfaceClass pyams_utils.interfaces.tales.ITALESExtension>
-2018-01-14 11:37:54,847 DEBUG [PyAMS (utils)][MainThread] Registering adapter <class 'pyams_utils.widget.decimal.DottedDecimalDataConverter'> for (<InterfaceClass pyams_utils.schema.IDottedDecimalField>, <InterfaceClass z3c.form.interfaces.IWidget>) providing <InterfaceClass z3c.form.interfaces.IDataConverter>
-2018-01-14 11:37:54,942 DEBUG [PyAMS (utils)][MainThread] Registering adapter <class 'pyams_utils.zmi.intids.IntIdsLengthAdapter'> for (<InterfaceClass zope.intid.interfaces.IIntIds>,) providing <InterfaceClass pyams_utils.interfaces.intids.IIndexLength>
-2018-01-14 11:37:54,943 DEBUG [PyAMS (pagelet)][MainThread] Registering pagelet view "properties.html" for <InterfaceClass zope.intid.interfaces.IIntIds> (<class 'pyams_utils.zmi.intids.IntIdsPropertiesDisplayForm'>)
-2018-01-14 11:37:54,949 DEBUG [PyAMS (pagelet)][MainThread] Registering pagelet view "properties.html" for <InterfaceClass pyams_utils.interfaces.timezone.IServerTimezone> (<class 'pyams_utils.zmi.timezone.ServerTimezonePropertiesEditForm'>)
-2018-01-14 11:37:54,980 DEBUG [PyAMS (utils)][MainThread] Registering class <class 'pyams_utils.zodb.ZEOConnectionVocabulary'> as vocabulary with name "PyAMS ZEO connections"
-2018-01-14 11:37:54,981 DEBUG [PyAMS (utils)][MainThread] Registering class <class 'pyams_utils.zodb.ZODBConnectionVocabulary'> as vocabulary with name "PyAMS ZODB connections"
-2018-01-14 11:37:55,015 DEBUG [PyAMS (pagelet)][MainThread] Registering pagelet view "add-zeo-connection.html" for <InterfaceClass zope.component.interfaces.ISite> (<class 'pyams_utils.zmi.zeo.ZEOConnectionAddForm'>)
-2018-01-14 11:37:55,016 DEBUG [PyAMS (utils)][MainThread] Registering adapter <class 'pyams_utils.zmi.zeo.ZEOConnectionNameAdapter'> for (<InterfaceClass pyams_utils.interfaces.zeo.IZEOConnection>, <InterfaceClass pyams_zmi.layer.IAdminLayer>) providing <InterfaceClass pyams_skin.interfaces.container.ITableElementName>
-2018-01-14 11:37:55,017 DEBUG [PyAMS (pagelet)][MainThread] Registering pagelet view "properties.html" for <InterfaceClass pyams_utils.interfaces.zeo.IZEOConnection> (<class 'pyams_utils.zmi.zeo.ZEOConnectionPropertiesEditForm'>)
-...
-2018-01-14 11:41:13,214 DEBUG [PyAMS (utils)][MainThread] Registering adapter <class 'pyams_default_theme.skin.ResourcesAdapter'> for (<InterfaceClass zope.interface.Interface>, <InterfaceClass pyams_default_theme.layer.IPyAMSDefaultLayer>, <InterfaceClass zope.interface.Interface>) providing <InterfaceClass pyams_skin.interfaces.resources.IResources>
-2018-01-14 11:43:36,665 INFO  [ZEO.ClientStorage][MainThread] [('127.0.0.1', 8100)] ClientStorage (pid=29335) created RW/normal for storage: 'pyams'
-2018-01-14 11:43:36,665 INFO  [ZEO.cache][MainThread] created temporary cache file 9
-2018-01-14 11:43:36,673 DEBUG [asyncio][[('127.0.0.1', 8100)] zeo client networking thread] Using selector: EpollSelector
-2018-01-14 11:43:36,674 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328 Checking blob cache size. (target: 966367642)
-2018-01-14 11:43:36,674 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] disconnected <ZEO.asyncio.client.Client object at 0x7ffa54058860> None
-2018-01-14 11:43:36,675 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328   blob cache size: 0
-2018-01-14 11:43:36,675 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] try_connecting
-2018-01-14 11:43:36,675 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328   -->
-2018-01-14 11:43:36,677 INFO  [ZEO.asyncio.base][[('127.0.0.1', 8100)] zeo client networking thread] Connected Protocol(('127.0.0.1', 8100), 'pyams', False)
-2018-01-14 11:43:36,679 INFO  [ZEO.ClientStorage][[('127.0.0.1', 8100)] zeo client networking thread] [('127.0.0.1', 8100)] Connected to storage: ('localhost', 8100)
-2018-01-14 11:43:36,682 DEBUG [txn.140713340237568][MainThread] new transaction
-2018-01-14 11:43:36,683 DEBUG [txn.140713340237568][MainThread] commit
-2018-01-14 11:43:36,690 INFO  [PyAMS (scheduler][MainThread] Starting tasks scheduler <SchedulerProcess(SchedulerProcess-1, initial)>...
-2018-01-14 11:43:36,698 INFO  [PyAMS (scheduler][MainThread] Started tasks scheduler with PID 29361.
-2018-01-14 11:43:36,701 INFO  [apscheduler.scheduler][MainThread] Scheduler started
-2018-01-14 11:43:36,702 DEBUG [apscheduler.scheduler][APScheduler] Looking for jobs to run
-2018-01-14 11:43:36,704 DEBUG [apscheduler.scheduler][APScheduler] No jobs; waiting until a job is added
-2018-01-14 11:43:36,719 INFO  [ZEO.ClientStorage][MainThread] [('127.0.0.1', 8100)] ClientStorage (pid=29335) created RW/normal for storage: 'pyams'
-2018-01-14 11:43:36,720 INFO  [ZEO.cache][MainThread] created temporary cache file 15
-2018-01-14 11:43:36,724 DEBUG [asyncio][[('127.0.0.1', 8100)] zeo client networking thread] Using selector: EpollSelector
-2018-01-14 11:43:36,725 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] disconnected <ZEO.asyncio.client.Client object at 0x7ffa557e8b00> None
-2018-01-14 11:43:36,726 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] try_connecting
-2018-01-14 11:43:36,727 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328 Checking blob cache size. (target: 966367642)
-2018-01-14 11:43:36,728 INFO  [ZEO.asyncio.base][[('127.0.0.1', 8100)] zeo client networking thread] Connected Protocol(('127.0.0.1', 8100), 'pyams', False)
-2018-01-14 11:43:36,729 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328   blob cache size: 0
-2018-01-14 11:43:36,729 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328   -->
-2018-01-14 11:43:36,732 INFO  [ZEO.ClientStorage][[('127.0.0.1', 8100)] zeo client networking thread] [('127.0.0.1', 8100)] Connected to storage: ('localhost', 8100)
-2018-01-14 11:43:36,735 DEBUG [txn.140713340237568][MainThread] new transaction
-2018-01-14 11:43:36,736 DEBUG [txn.140713340237568][MainThread] commit
-2018-01-14 11:43:36,743 INFO  [PyAMS (media)][MainThread] Starting medias converter <MediaConversionProcess(MediaConversionProcess-2, initial)>...
-2018-01-14 11:43:36,751 INFO  [PyAMS (media)][MainThread] Started medias converter with PID 29367.
-Starting server in PID 29335.
-Serving on http://0.0.0.0:6543
-
-
-

From this point, you can launch a browser and open URL http://127.0.0.1:6543/admin to get access to PyAMS -management interface; default login is “admin/admin”, that you may change as soon as possible (see -PyAMS security)!!.

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_alchemy.interfaces.html --- a/src/build/html/pyams_alchemy.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_alchemy.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_alchemy.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_cache.html --- a/src/build/html/pyams_cache.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,177 +0,0 @@ - - - - - - - PyAMS cache management — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

PyAMS cache management

-
-

Module contents

-
-
-pyams_cache.includeme(config)
-

Pyramid include

-
- -
-
-

Submodules

-
-

pyams_cache.beaker module

-
-
-pyams_cache.beaker.get_cache(region, cache_name)
-

Get Beaker cache matching given name

-
- -
-
-

pyams_cache.cache module

-
-
-pyams_cache.cache.get_cache_handler(server, interface=<InterfaceClass pyams_cache.interfaces.ICacheHandler>)
-

Get handler for given server and interface

-
- -
-
-

pyams_cache.include module

-
-
-pyams_cache.include.include_package(config)
-

Pyramid include

-
- -
-
- -
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_cache.interfaces.html --- a/src/build/html/pyams_cache.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_cache.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_cache.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_cache.tests.html --- a/src/build/html/pyams_cache.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,145 +0,0 @@ - - - - - - - pyams_cache.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_cache.tests package

-
-

Module contents

-
-
-

Submodules

-
-

pyams_cache.tests.test_utilsdocs module

-

Generic Test case for pyams_cache doctest

-
-
-pyams_cache.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_cache.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_cache.tests.test_utilsdocstrings module

-

Generic Test case for pyams_cache doc strings

-
-
-pyams_cache.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_cache.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_catalog.tests.html --- a/src/build/html/pyams_catalog.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_catalog.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_catalog.tests package

-
-

Submodules

-
-
-

pyams_catalog.tests.test_utilsdocs module

-

Generic Test case for pyams_catalog doctest

-
-
-pyams_catalog.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_catalog.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_catalog.tests.test_utilsdocstrings module

-

Generic Test case for pyams_catalog doc strings

-
-
-pyams_catalog.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_catalog.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_catalog.zmi.html --- a/src/build/html/pyams_catalog.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,385 +0,0 @@ - - - - - - - pyams_catalog.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_catalog.zmi package

-
-

Submodules

-
-
-

pyams_catalog.zmi.catalog module

-
-
-class pyams_catalog.zmi.catalog.CatalogIndexClassColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Catalog index class column

-
-
-getValue(obj)
-
- -
-
-weight = 2
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexDiscriminatorColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Catalog index discriminator column

-
-
-getValue(obj)
-
- -
-
-weight = 4
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexInterfaceColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Catalog index interface column

-
-
-getValue(obj)
-
- -
-
-weight = 3
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexNameColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Catalog index name column

-
-
-attrName = '__name__'
-
- -
-
-weight = 1
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexNbDocsColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Catalog index documents count column

-
-
-cssClasses = {'td': 'center'}
-
- -
-
-getValue(obj)
-
- -
-
-weight = 5
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexNbIndexedColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Catalog index documents indexed column

-
-
-cssClasses = {'td': 'center'}
-
- -
-
-getValue(obj)
-
- -
-
-weight = 6
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexNbUnindexedColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Catalog index documents not-indexed column

-
-
-cssClasses = {'td': 'center'}
-
- -
-
-getValue(obj)
-
- -
-
-weight = 7
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexNbWordsColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Catalog index documents count column

-
-
-cssClasses = {'td': 'center'}
-
- -
-
-getValue(obj)
-
- -
-
-weight = 10
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexTrashColumn(context, request, table)
-

Bases: pyams_skin.table.TrashColumn

-

Catalog index trash column

-
-
-has_permission(item)
-
- -
-
-icon_hint = 'Delete index'
-
- -
-
-permission = 'pyams.ManageSystem'
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexesTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Catalog indexes table

-
-
-cssClasses = {'table': 'table table-bordered table-striped table-hover table-tight datatable'}
-
- -
-
-data_attributes
-
- -
-
-id = 'CatalogIndexes'
-
- -
-
-sortOn = None
-
- -
-
-title = 'Catalog indexes'
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexesValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Catalog indexes values adapter

-
-
-values
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogIndexesViewlet(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Catalog indexes viewlet

-
-
-table = None
-
- -
-
-update()
-
- -
- -
-
-class pyams_catalog.zmi.catalog.CatalogPropertiesDisplayForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogDisplayForm

-

Catalog properties display form

-
-
-dialog_class = 'modal-max'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Display catalog indexes'
-
- -
-
-title
-
- -
- -
-
-pyams_catalog.zmi.catalog.delete_catalog_index(request)
-

Delete index from catalog

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.association.zmi.html --- a/src/build/html/pyams_content.component.association.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,580 +0,0 @@ - - - - - - - pyams_content.component.association.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component.association.zmi package

-
-

Submodules

-
-
-

pyams_content.component.association.zmi.interfaces module

-
-
-

pyams_content.component.association.zmi.paragraph module

-
-
-class pyams_content.component.association.zmi.paragraph.AssociationParagraphAJAXAddForm(context, request)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphAJAXAddForm, pyams_content.component.association.zmi.paragraph.AssociationParagraphAddForm

-

Association paragraph add form, JSON renderer

-
- -
-
-class pyams_content.component.association.zmi.paragraph.AssociationParagraphAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Association paragraph add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-association-paragraph.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-link'
-
- -
-
-legend = 'Add new association paragraph'
-
- -
- -
-
-class pyams_content.component.association.zmi.paragraph.AssociationParagraphAddMenu(context, request, view, manager)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphAddMenu

-

Associations paragraph add menu

-
-
-label = 'Add associations paragraph...'
-
- -
-
-label_css_class = 'fa fa-fw fa-link'
-
- -
-
-paragraph_type = 'Associations'
-
- -
-
-url = 'add-association-paragraph.html'
-
- -
- -
-
-class pyams_content.component.association.zmi.paragraph.AssociationParagraphInnerEditForm(context, request)
-

Bases: pyams_content.component.association.zmi.paragraph.AssociationParagraphPropertiesEditForm

-

Association paragraph inner edit form

-
-
-buttons
-
- -
-
-legend = None
-
- -
- -
-
-class pyams_content.component.association.zmi.paragraph.AssociationParagraphPropertiesAJAXEditForm(context, request)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphAJAXEditForm, pyams_content.component.association.zmi.paragraph.AssociationParagraphPropertiesEditForm

-

Association paragraph properties edit form, JSON renderer

-
- -
-
-class pyams_content.component.association.zmi.paragraph.AssociationParagraphPropertiesEditForm(context, request)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphPropertiesEditForm

-

Association paragraph properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-link'
-
- -
-
-legend = 'Edit association paragraph properties'
-
- -
-
-title
-
- -
- -
-
-class pyams_content.component.association.zmi.paragraph.AssociationParagraphSummary(context, request)
-

Bases: pyams_viewlet.viewlet.BaseContentProvider

-

Association paragraph renderer

-
-
-associations = None
-
- -
-
-language = None
-
- -
-
-update()
-
- -
- -
-
-

Module contents

-
-
-class pyams_content.component.association.zmi.AssociationItemAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm

-

Association item add form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationItemAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm

-

Association item properties edit form, JSON renderer

-
-
-get_associations_table()
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsContainerDialogView(context, request)
-

Bases: pyams_zmi.form.AdminDialogDisplayForm

-

Associations dialog view

-
-
-dialog_class = 'modal-large no-widget-toolbar'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-fieldset_class = 'height-300'
-
- -
-
-title = 'Associations list'
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsContainerView(context, request)
-

Bases: pyams_zmi.view.ContainerAdminView, pyams_pagelet.pagelet.Pagelet

-

Associations container view

-
-
-table_class
-

alias of AssociationsTable

-
- -
-
-title = 'Associations list'
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Associations menu

-
-
-icon_class = 'fa-link'
-
- -
-
-label = 'Associations...'
-
- -
-
-url = '#associations.html'
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsTable(context, request)
-

Bases: pyams_form.security.ProtectedFormObjectMixin, pyams_skin.table.BaseTable

-

Associations view inner table

-
-
-cssClasses
-
- -
-
-data_attributes
-
- -
-
-hide_header = True
-
- -
-
-id
-
- -
-
-sortOn = None
-
- -
-
-values
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsTableInnerNameColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Associations table inner name column

-
-
-getValue(obj)
-
- -
-
-weight = 20
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsTablePictogramColumn(context, request, table)
-

Bases: pyams_skin.table.ImageColumn

-

Associations table pictogram column

-
-
-get_icon_class(item)
-
- -
-
-get_icon_hint(item)
-
- -
-
-weight = 8
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsTablePublicNameColumn(context, request, table)
-

Bases: pyams_skin.table.NameColumn

-

Associations table name column

-
-
-getValue(obj)
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsTableShowHideColumn(context, request, table)
-

Bases: pyams_form.security.ProtectedFormObjectMixin, pyams_skin.table.JsActionColumn

-

Associations container visibility switcher column

-
-
-cssClasses = {'td': 'action switcher', 'th': 'action'}
-
- -
-
-get_icon(item)
-
- -
-
-icon_class = 'fa fa-fw fa-eye'
-
- -
-
-icon_hint = 'Switch association visibility'
-
- -
-
-renderCell(item)
-
- -
-
-url = 'PyAMS_content.associations.switchVisibility'
-
- -
-
-weight = 5
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsTableSizeColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Associations table size column

-
-
-getValue(obj)
-
- -
-
-weight = 30
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsTableSorterColumn(context, request, table)
-

Bases: pyams_form.security.ProtectedFormObjectMixin, pyams_skin.table.SorterColumn

-

Associations table sorter column

-
- -
-
-class pyams_content.component.association.zmi.AssociationsTableTrashColumn(context, request, table)
-

Bases: pyams_form.security.ProtectedFormObjectMixin, pyams_skin.table.TrashColumn

-

Associations table trash column

-
- -
-
-class pyams_content.component.association.zmi.AssociationsTableValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Associations table values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.component.association.zmi.AssociationsView(context, request, view)
-

Bases: pyams_zmi.form.InnerAdminDisplayForm

-

Associations view

-
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-update()
-
- -
-
-weight = 90
-
- -
- -
-
-pyams_content.component.association.zmi.delete_association(request)
-

Delete association

-
- -
-
-pyams_content.component.association.zmi.set_associations_order(request)
-

Update asociations order

-
- -
-
-pyams_content.component.association.zmi.set_paragraph_visibility(request)
-

Set paragraph visibility

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.gallery.html --- a/src/build/html/pyams_content.component.gallery.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,490 +0,0 @@ - - - - - - - pyams_content.component.gallery package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component.gallery package

- -
-

Submodules

-
-
-

pyams_content.component.gallery.file module

-
-
-class pyams_content.component.gallery.file.GalleryFile
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Gallery file info

-
-
-alt_title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-author
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-author_comments
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-data
-
- -
-
-description
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-pif_number
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-sound
-

Property class used to handle files

-
- -
-
-sound_description
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-sound_title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-visible
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_content.component.gallery.file.GalleryFileContentChecker(context)
-

Bases: pyams_content.features.checker.BaseContentChecker

-

Gallery file content checker

-
-
-inner_check(request)
-
- -
-
-label
-
- -
- -
-
-class pyams_content.component.gallery.file.GalleryFilePermissionChecker(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Gallery file permission checker

-
-
-edit_permission
-
- -
- -
- -

Handle added gallery file

-
- -
- -

Handle modified gallery file

-
- -
- -

Handle removed gallery file

-
- -
-
-

pyams_content.component.gallery.paragraph module

-
-
-class pyams_content.component.gallery.paragraph.Gallery
-

Bases: pyams_content.component.gallery.Gallery, pyams_content.component.paragraph.BaseParagraph

-

Gallery class

-
-
-icon_class = 'fa-picture-o'
-
- -
-
-icon_hint = 'Images gallery'
-
- -
- -
-
-class pyams_content.component.gallery.paragraph.GalleryFactory
-

Bases: object

-

Gallery paragraph factory

-
-
-content_type
-

alias of Gallery

-
- -
-
-name = 'Images gallery'
-
- -
- -
-
-class pyams_content.component.gallery.paragraph.GalleryParagraphContentChecker(context)
-

Bases: pyams_content.component.paragraph.BaseParagraphContentChecker

-

Gallery paragraph content checker

-
-
-inner_check(request)
-
- -
- -
-
-

Module contents

-
-
-class pyams_content.component.gallery.Gallery
-

Bases: pyams_utils.container.BTreeOrderedContainer

-

Gallery persistent class

-
-
-append(value, notify=True)
-
- -
-
-description
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-get_visible_images()
-
- -
-
-last_id = 1
-
- -
-
-renderer
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_content.component.gallery.GalleryContainerNamespace(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

++gallery++ namespace traverser

-
-
-traverse(name, furtherpath=None)
-
- -
- -
-
-class pyams_content.component.gallery.GalleryContainerSublocations(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Galleries container sublocations

-
-
-sublocations()
-
- -
- -
-
-class pyams_content.component.gallery.GalleryContentChecker(context)
-

Bases: pyams_content.features.checker.BaseContentChecker

-

Gallery content checker

-
-
-inner_check(request)
-
- -
-
-label = 'Gallery'
-
- -
-
-sep = '\n'
-
- -
-
-weight = 60
-
- -
- -
-
-class pyams_content.component.gallery.GalleryPermissionChecker(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Gallery permission checker

-
-
-edit_permission
-
- -
- -
-
-class pyams_content.component.gallery.GalleryRendererVocabulary(context=None)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

Gallery renderer utilities vocabulary

-
- -
-
-pyams_content.component.gallery.GalleryTargetContentChecker(context)
-
- -
-
-pyams_content.component.gallery.gallery_factory(target)
-

Galleries container factory

-
- -
- -

Handle added gallery

-
- -
- -

Handle modified gallery

-
- -
- -

Handle removed gallery

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.gallery.zmi.html --- a/src/build/html/pyams_content.component.gallery.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,703 +0,0 @@ - - - - - - - pyams_content.component.gallery.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component.gallery.zmi package

-
-

Submodules

-
-
-

pyams_content.component.gallery.zmi.file module

-
-
-class pyams_content.component.gallery.zmi.file.GalleryFileInfoPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.component.gallery.zmi.file.GalleryFilePropertiesEditForm

-

Gallery file properties edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.gallery.zmi.file.GalleryFilePropertiesAction(context, request, view, manager)
-

Bases: pyams_file.zmi.file.FilePropertiesAction

-

Media properties action

-
-
-url = 'gallery-file-properties.html'
-
- -
- -
-
-class pyams_content.component.gallery.zmi.file.GalleryFilePropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Gallery file properties edit form

-
-
-ajax_handler = 'gallery-file-properties.json'
-
- -
-
-dialog_class = 'modal-large'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-picture-o'
-
- -
-
-legend = 'Update image properties'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.gallery.zmi.file.GalleryFileRemoverAction(context, request, view, manager)
-

Bases: pyams_content.shared.common.zmi.WfSharedContentPermissionMixin, pyams_skin.viewlet.toolbar.JsToolbarActionItem

-

Gallery file remover action

-
-
-hint_gravity = 'nw'
-
- -
-
-label = 'Remove image...'
-
- -
-
-label_css_class = 'fa fa-fw fa-trash'
-
- -
-
-url = 'PyAMS_content.galleries.removeFile'
-
- -
- -
-
-class pyams_content.component.gallery.zmi.file.GalleryFileShowHideAction(context, request, view, manager)
-

Bases: pyams_content.shared.common.zmi.WfSharedContentPermissionMixin, pyams_skin.viewlet.toolbar.JsToolbarActionItem

-

Gallery file show/hide action

-
-
-edit_permission = 'system.forbidden'
-
- -
-
-get_url()
-
- -
-
-hint_gravity = 'nw'
-
- -
-
-label
-
- -
-
-label_css_class
-
- -
-
-url = 'PyAMS_content.galleries.switchImageVisibility'
-
- -
- -
-
-class pyams_content.component.gallery.zmi.file.GalleryImageAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.component.gallery.zmi.file.GalleryImageAddForm

-

Gallery image add form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.gallery.zmi.file.GalleryImageAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Gallery image add form

-
-
-ajax_handler = 'add-image.json'
-
- -
-
-create(data)
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa -fa-fw fa-picture-o'
-
- -
-
-legend = 'Add image(s)'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.gallery.zmi.file.GalleryImageAddMenu(context, request, view, manager)
-

Bases: pyams_content.shared.common.zmi.WfSharedContentPermissionMixin, pyams_skin.viewlet.toolbar.ToolbarAction

-

Gallery image add menu

-
-
-label = 'Add image(s)'
-
- -
-
-modal_target = True
-
- -
-
-stop_propagation = True
-
- -
-
-url = 'add-image.html'
-
- -
- -
- -

Delete gallery element

-
- -
-
-

pyams_content.component.gallery.zmi.interfaces module

-
-
-

pyams_content.component.gallery.zmi.paragraph module

-
-
-class pyams_content.component.gallery.zmi.paragraph.GalleryAJAXAddForm(context, request)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphAJAXAddForm, pyams_content.component.gallery.zmi.paragraph.GalleryAddForm

-

Gallery paragraph add form, JSON renderer

-
- -
-
-class pyams_content.component.gallery.zmi.paragraph.GalleryAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Gallery add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-gallery.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-picture-o'
-
- -
-
-legend = 'Add new gallery'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.gallery.zmi.paragraph.GalleryAddMenu(context, request, view, manager)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphAddMenu

-

Gallery add menu

-
-
-label = 'Add images gallery...'
-
- -
-
-label_css_class = 'fa fa-fw fa-picture-o'
-
- -
-
-paragraph_type = 'Gallery'
-
- -
-
-url = 'add-gallery.html'
-
- -
- -
-
-class pyams_content.component.gallery.zmi.paragraph.GalleryContentsView(context, request, view=None)
-

Bases: pyams_content.shared.common.zmi.WfSharedContentPermissionMixin, pyams_zmi.form.InnerAdminDisplayForm

-

Gallery contents edit form

-
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-get_title(image)
-
- -
-
-weight = 10
-
- -
- -
-
-class pyams_content.component.gallery.zmi.paragraph.GalleryImageAddMenu(context, request, view, manager)
-

Bases: pyams_content.shared.common.zmi.WfSharedContentPermissionMixin, pyams_skin.viewlet.toolbar.ToolbarAction

-

Gallery image add menu

-
-
-label = 'Add image(s)'
-
- -
-
-modal_target = True
-
- -
-
-stop_propagation = True
-
- -
-
-url = 'add-image.html'
-
- -
- -
-
-class pyams_content.component.gallery.zmi.paragraph.GalleryInnerEditForm(context, request)
-

Bases: pyams_content.component.gallery.zmi.paragraph.GalleryPropertiesEditForm

-

Gallery properties inner edit form

-
-
-buttons
-
- -
-
-legend = None
-
- -
- -
-
-class pyams_content.component.gallery.zmi.paragraph.GalleryParagraphSummary(context, request)
-

Bases: pyams_viewlet.viewlet.BaseContentProvider

-

Gallery summary

-
-
-language = None
-
- -
-
-render()
-
- -
-
-update()
-
- -
- -
-
-class pyams_content.component.gallery.zmi.paragraph.GalleryPropertiesAJAXEditForm(context, request)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphAJAXEditForm, pyams_content.component.gallery.zmi.paragraph.GalleryPropertiesEditForm

-

Gallery paragraph properties edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.gallery.zmi.paragraph.GalleryPropertiesEditForm(context, request)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphPropertiesEditForm

-

Gallery properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-picture-o'
-
- -
-
-legend = 'Edit gallery properties'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-

Module contents

-
-
-class pyams_content.component.gallery.zmi.BaseGalleryRenderer(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

Base gallery renderer

-
-
-render = <BoundViewTemplate of None>
-
- -
-
-update()
-
- -
- -
-
-class pyams_content.component.gallery.zmi.DefaultGalleryRenderer(context, request)
-

Bases: pyams_content.component.gallery.zmi.BaseGalleryRenderer

-

Default gallery renderer

-
-
-label = 'Default gallery renderer'
-
- -
-
-weight = 1
-
- -
- -
-
-class pyams_content.component.gallery.zmi.GalleryContentForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogDisplayForm

-

Gallery contents form

-
-
-dialog_class = 'modal-max'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Update gallery contents'
-
- -
-
-show_widget_title = True
-
- -
- -
-
-class pyams_content.component.gallery.zmi.GalleryImagesView(context, request)
-

Bases: pyams_content.shared.common.zmi.WfSharedContentPermissionMixin

-

Gallery images view

-
-
-get_title(image)
-
- -
- -
-
-class pyams_content.component.gallery.zmi.GalleryImagesViewlet(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Gallery images viewlet

-
-
-get_title(image)
-
- -
- -
-
-class pyams_content.component.gallery.zmi.GalleryPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.component.gallery.zmi.GalleryPropertiesEditForm

-

Gallery properties edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.gallery.zmi.GalleryPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Gallery properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-picture-o'
-
- -
-
-legend = 'Update gallery properties'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-pyams_content.component.gallery.zmi.get_images_archive(request)
-

Get all gallery images as ZIP file

-
- -
-
-pyams_content.component.gallery.zmi.set_image_visibility(request)
-

Set gallery image visibility

-
- -
-
-pyams_content.component.gallery.zmi.set_images_order(request)
-

Set gallery images order

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.html --- a/src/build/html/pyams_content.component.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,265 +0,0 @@ - - - - - - - pyams_content.component package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component package

-
-

Subpackages

-
- -
-
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.illustration.html --- a/src/build/html/pyams_content.component.illustration.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,343 +0,0 @@ - - - - - - - pyams_content.component.illustration package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component.illustration package

- -
-

Submodules

-
-
-

pyams_content.component.illustration.paragraph module

-
-
-class pyams_content.component.illustration.paragraph.Illustration
-

Bases: pyams_content.component.illustration.Illustration, pyams_content.component.paragraph.BaseParagraph

-

Illustration class

-
-
-icon_class = 'fa-file-image-o'
-
- -
-
-icon_hint = 'Illustration'
-
- -
- -
-
-class pyams_content.component.illustration.paragraph.IllustrationFactory
-

Bases: object

-

Illustration paragraph factory

-
-
-content_type
-

alias of Illustration

-
- -
-
-name = 'Illustration'
-
- -
- -
-
-class pyams_content.component.illustration.paragraph.IllustrationParagraphContentChecker(context)
-

Bases: pyams_content.component.illustration.IllustrationContentChecker

-

Illustration paragraph content checker

-
-
-label
-
- -
- -
-
-

Module contents

-
-
-class pyams_content.component.illustration.Illustration
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Illustration persistent class

-
-
-alt_title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-author
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-data
-
- -
-
-description
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-filename
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-language
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-renderer
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_content.component.illustration.IllustrationContentChecker(context)
-

Bases: pyams_content.features.checker.BaseContentChecker

-

Illustration content checker

-
-
-inner_check(request)
-
- -
-
-label = 'Illustration'
-
- -
-
-weight = 40
-
- -
- -
-
-class pyams_content.component.illustration.IllustrationNamespace(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

++illustration++ namespace adapter

-
-
-traverse(name, furtherpath=None)
-
- -
- -
-
-class pyams_content.component.illustration.IllustrationRendererVocabulary(context=None)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

Illustration renderer utilities vocabulary

-
- -
-
-class pyams_content.component.illustration.IllustrationSublocations(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Illustration sub-locations adapter

-
-
-sublocations()
-
- -
- -
-
-pyams_content.component.illustration.IllustrationTargetContentChecker(context)
-

Illustration target content checker

-
- -
-
-pyams_content.component.illustration.handle_added_illustration(event)
-

Handle added illustration

-
- -
-
-pyams_content.component.illustration.handle_modified_illustration(event)
-

Handle modified illustration

-
- -
-
-pyams_content.component.illustration.illustration_factory(context)
-

Illustration factory

-
- -
-
-pyams_content.component.illustration.update_illustration_properties(illustration)
-

Update missing file properties

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.illustration.interfaces.html --- a/src/build/html/pyams_content.component.illustration.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_content.component.illustration.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component.illustration.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.links.interfaces.html --- a/src/build/html/pyams_content.component.links.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_content.component.links.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component.links.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.links.zmi.html --- a/src/build/html/pyams_content.component.links.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,696 +0,0 @@ - - - - - - - pyams_content.component.links.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component.links.zmi package

-
-

Submodules

-
-
-

pyams_content.component.links.zmi.container module

-
- -

Get links list in JSON format for TinyMCE editor

-
- -
- -

Get links list in JSON format for TinyMCE editor

-
- -
-
-

pyams_content.component.links.zmi.reverse module

-
-
-class pyams_content.component.links.zmi.reverse.ReverseLinkNameColumn(context, request, table)
-

Bases: pyams_skin.table.NameColumn

-

Reverse link name column

-
- -
-
-class pyams_content.component.links.zmi.reverse.SequentialITargetReverseLinksMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Sequential ID target reverse links menu

-
-
-icon_class = 'fa-anchor'
-
- -
-
-label = 'Reverse links'
-
- -
-
-url = '#reverse-links.html'
-
- -
- -
-
-class pyams_content.component.links.zmi.reverse.SequentialIdTargetReverseLinkTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Sequential ID target reverse links table

-
-
-title = "Content's internal links"
-
- -
- -
-
-class pyams_content.component.links.zmi.reverse.SequentialIdTargetReverseLinkValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Sequential ID target reverse links values

-
-
-values
-
- -
- -
-
-class pyams_content.component.links.zmi.reverse.SequentialIdTargetReverseLinkView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

-

Sequential ID target reverse links view

-
-
-table_class
-

alias of SequentialIdTargetReverseLinkTable

-
- -
- -
-
-

Module contents

-
-
-class pyams_content.component.links.zmi.ExternalLinkAJAXAddForm(context, request)
-

Bases: pyams_content.component.association.zmi.AssociationItemAJAXAddForm, pyams_content.component.links.zmi.ExternalLinkAddForm

-

External link add form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.links.zmi.ExternalLinkAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

External link add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-external-link.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-external-link'
-
- -
-
-legend = 'Add new external link'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.links.zmi.ExternalLinkAddMenu(context, request, view, manager)
-

Bases: pyams_form.security.ProtectedFormObjectMixin, pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

External link add menu

-
-
-label = 'Add external link'
-
- -
-
-label_css_class = 'fa fa-fw fa-external-link'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-external-link.html'
-
- -
- -
-
-class pyams_content.component.links.zmi.ExternalLinkPropertiesAJAXEditForm(context, request)
-

Bases: pyams_content.component.association.zmi.AssociationItemAJAXEditForm, pyams_content.component.links.zmi.ExternalLinkPropertiesEditForm

-

External link properties edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.links.zmi.ExternalLinkPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

External link properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-external-link'
-
- -
-
-legend = 'Edit external link properties'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.links.zmi.ExternalLinksCounter(context, request, view, manager)
-

Bases: pyams_content.component.paragraph.zmi.container.ParagraphContainerCounterBase

-

External links count column

-
-
-action_class = 'action external-links nowrap width-40'
-
- -
-
-count
-
- -
-
-icon_class = 'fa fa-fw fa-external-link'
-
- -
-
-icon_hint = 'External links'
-
- -
-
-weight = 11
-
- -
- -
-
-class pyams_content.component.links.zmi.InternalLinkAJAXAddForm(context, request)
-

Bases: pyams_content.component.association.zmi.AssociationItemAJAXAddForm, pyams_content.component.links.zmi.InternalLinkAddForm

-

Internal link add form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.links.zmi.InternalLinkAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Internal link add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-internal-link.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-external-link-square fa-rotate-90'
-
- -
-
-legend = 'Add new internal link'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.links.zmi.InternalLinkAddMenu(context, request, view, manager)
-

Bases: pyams_form.security.ProtectedFormObjectMixin, pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Internal link add menu

-
-
-label = 'Add internal link'
-
- -
-
-label_css_class = 'fa fa-fw fa-external-link-square fa-rotate-90'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-internal-link.html'
-
- -
- -
-
-class pyams_content.component.links.zmi.InternalLinkPropertiesAJAXEditForm(context, request)
-

Bases: pyams_content.component.association.zmi.AssociationItemAJAXEditForm, pyams_content.component.links.zmi.InternalLinkPropertiesEditForm

-

Internal link properties edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.links.zmi.InternalLinkPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Internal link properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-external-link-square fa-rotate-90'
-
- -
-
-legend = 'Edit internal link properties'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.links.zmi.InternalLinksCounter(context, request, view, manager)
-

Bases: pyams_content.component.paragraph.zmi.container.ParagraphContainerCounterBase

-

Internal links count column

-
-
-action_class = 'action internal-links nowrap width-40'
-
- -
-
-count
-
- -
-
-icon_class = 'fa fa-fw fa-external-link-square fa-rotate-90'
-
- -
-
-icon_hint = 'Internal links'
-
- -
-
-weight = 10
-
- -
- -
-
-class pyams_content.component.links.zmi.MailtoLinkAJAXAddForm(context, request)
-

Bases: pyams_content.component.association.zmi.AssociationItemAJAXAddForm, pyams_content.component.links.zmi.MailtoLinkAddForm

-

Mailto link add form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.links.zmi.MailtoLinkAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Mailto link add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-mailto-link.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-envelope-o'
-
- -
-
-legend = 'Add new mailto link'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.links.zmi.MailtoLinkAddMenu(context, request, view, manager)
-

Bases: pyams_form.security.ProtectedFormObjectMixin, pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Mailto link add menu

-
-
-label = 'Add mailto link'
-
- -
-
-label_css_class = 'fa fa-fw fa-envelope-o'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-mailto-link.html'
-
- -
- -
-
-class pyams_content.component.links.zmi.MailtoLinkPropertiesAJAXEditForm(context, request)
-

Bases: pyams_content.component.association.zmi.AssociationItemAJAXEditForm, pyams_content.component.links.zmi.MailtoLinkPropertiesEditForm

-

Mailto link properties edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.component.links.zmi.MailtoLinkPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Mailto link properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-envelope-o'
-
- -
-
-legend = 'Edit mailto link properties'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.links.zmi.MailtoLinksCounter(context, request, view, manager)
-

Bases: pyams_content.component.paragraph.zmi.container.ParagraphContainerCounterBase

-

Mailto links count column

-
-
-action_class = 'action mailto-links nowrap width-40'
-
- -
-
-count
-
- -
-
-icon_class = 'fa fa-fw fa-envelope-o'
-
- -
-
-icon_hint = 'Mailto links'
-
- -
-
-weight = 12
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.theme.html --- a/src/build/html/pyams_content.component.theme.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,235 +0,0 @@ - - - - - - - pyams_content.component.theme package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component.theme package

- -
-

Submodules

-
-
-

pyams_content.component.theme.portlet module

-
-
-class pyams_content.component.theme.portlet.PortletThemesSettings
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Portlet themes settings

-
- -
-
-pyams_content.component.theme.portlet.PortletThemesSettingsFactory(context)
-

Portlet themes settings adapter

-
- -
-
-class pyams_content.component.theme.portlet.ThemesPortletsSettingsTraverser(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

++themes++ portlet settings adapter

-
-
-traverse(name, furtherpath=None)
-
- -
- -
-
-

Module contents

-
-
-class pyams_content.component.theme.ThemesContentChecker(context)
-

Bases: pyams_content.features.checker.BaseContentChecker

-

Themes info content checker

-
-
-inner_check(request)
-
- -
-
-label = 'Themes'
-
- -
-
-weight = 200
-
- -
- -
-
-class pyams_content.component.theme.ThemesInfo
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Themes info persistent class

-
-
-themes
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_content.component.theme.ThemesInfoFactory(target)
-

Themes info factory

-
- -
-
-class pyams_content.component.theme.ThemesManager
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Themes manager persistent class

-
-
-extract_name
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-thesaurus_name
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_content.component.theme.ThemesManagerFactory(target)
-

Themes manager factory

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.theme.interfaces.html --- a/src/build/html/pyams_content.component.theme.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_content.component.theme.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component.theme.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.component.theme.zmi.html --- a/src/build/html/pyams_content.component.theme.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,293 +0,0 @@ - - - - - - - pyams_content.component.theme.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.component.theme.zmi package

-
-

Submodules

-
-
-

pyams_content.component.theme.zmi.manager module

-
-
-class pyams_content.component.theme.zmi.manager.ThemesManagerAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.component.theme.zmi.manager.ThemesManagerEditForm

-

Themes manager edit form, JSON renderer

-
- -
-
-class pyams_content.component.theme.zmi.manager.ThemesManagerEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Themes manager edit form

-
-
-ajax_handler = 'themes.json'
-
- -
-
-edit_permission = 'pyams.ManageTool'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Selected themes'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.theme.zmi.manager.ThemesManagerMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Themes menu

-
-
-icon_class = 'fa-tags'
-
- -
-
-label = 'Themes...'
-
- -
-
-modal_target = True
-
- -
-
-url = 'themes.html'
-
- -
- -
-
-

pyams_content.component.theme.zmi.portlet module

-
-
-class pyams_content.component.theme.zmi.portlet.PortletSettingsThemesEditor(context, request, view=None)
-

Bases: pyams_zmi.form.InnerAdminEditForm

-

Portlet settings for themes

-
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-id = 'themes_form'
-
- -
-
-legend = None
-
- -
-
-tab_label = 'Themes'
-
- -
-
-weight = 50
-
- -
- -
-
-

Module contents

-
-
-class pyams_content.component.theme.zmi.ThemesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.component.theme.zmi.ThemesEditForm

-

Themes edit form, JSON renderer

-
- -
-
-class pyams_content.component.theme.zmi.ThemesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminEditForm

-

Themes edit form

-
-
-ajax_handler = 'themes.json'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-get_subterms(term)
-
- -
-
-legend = 'Content themes'
-
- -
-
-top_terms
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.component.theme.zmi.ThemesHeaderAdapter(context, request, view)
-

Bases: pyams_content.shared.common.zmi.WfSharedContentHeaderAdapter

-

Shared content themes header adapter

-
-
-icon_class = 'fa fa-fw fa-tags'
-
- -
- -
-
-class pyams_content.component.theme.zmi.ThemesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Themes menu

-
-
-icon_class = 'fa-tags'
-
- -
-
-label = 'Themes...'
-
- -
-
-url = '#themes.html'
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.features.checker.html --- a/src/build/html/pyams_content.features.checker.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,157 +0,0 @@ - - - - - - - pyams_content.features.checker package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.features.checker package

- -
-

Submodules

-
-
-

pyams_content.features.checker.interfaces module

-
-
-

Module contents

-
-
-class pyams_content.features.checker.BaseContentChecker(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Base content checker

-
-
-get_check_output(request=None)
-
- -
-
-inner_check(request)
-
- -
-
-label = None
-
- -
-
-sep = '<br />'
-
- -
-
-weight = 1
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.features.checker.zmi.html --- a/src/build/html/pyams_content.features.checker.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,166 +0,0 @@ - - - - - - - pyams_content.features.checker.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.features.checker.zmi package

-
-

Module contents

-
-
-class pyams_content.features.checker.zmi.ContentCheckerForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogDisplayForm

-

Content checker display form

-
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-check-square-o'
-
- -
-
-legend = 'Content check'
-
- -
- -
-
-class pyams_content.features.checker.zmi.ContentCheckerMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Content checker menu item

-
-
-label = 'Check content...'
-
- -
-
-label_css_class = 'fa fa-fw fa-check-square-o'
-
- -
-
-modal_target = True
-
- -
-
-url = 'check-content.html'
-
- -
- -
-
-class pyams_content.features.checker.zmi.ContentCheckerWidgetsSuffix(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Content checker widgets suffix

-
-
-render()
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.features.html --- a/src/build/html/pyams_content.features.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,154 +0,0 @@ - - - - - - - pyams_content.features package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.features package

- -
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.features.preview.zmi.html --- a/src/build/html/pyams_content.features.preview.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,172 +0,0 @@ - - - - - - - pyams_content.features.preview.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.features.preview.zmi package

-
-

Submodules

-
-
-

pyams_content.features.preview.zmi.interfaces module

-
-
-

Module contents

-
-
-class pyams_content.features.preview.zmi.PreviewAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Content preview action

-
-
-css_class = 'btn btn-xs btn-default'
-
- -
-
-group_css_class = 'btn-group margin-right-10'
-
- -
-
-label = 'Preview'
-
- -
-
-label_css_class = 'fa fa-newspaper-o'
-
- -
-
-modal_target = True
-
- -
-
-url = 'preview.html'
-
- -
- -
-
-class pyams_content.features.preview.zmi.PreviewForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogDisplayForm

-

Content preview form

-
-
-dialog_class = 'modal-max'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Content preview'
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.generations.html --- a/src/build/html/pyams_content.generations.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,157 +0,0 @@ - - - - - - - pyams_content.generations package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.generations package

-
-

Module contents

-
-
-class pyams_content.generations.WebsiteGenerationsChecker
-

Bases: object

-

PyAMS content package generations checker

-
-
-evolve(site, current=None)
-

Check for required utilities

-
- -
-
-generation = 1
-
- -
- -
-
-pyams_content.generations.check_required_tools(site, config_interface, tools)
-

Check for required shared tools

-
- -
-
-pyams_content.generations.get_fulltext_lexicon(language)
-
- -
-
-pyams_content.generations.get_required_indexes()
-
- -
-
-pyams_content.generations.get_required_tools(manager, config, tools=[('views', <class 'pyams_content.shared.view.manager.ViewsManager'>), ('news', <class 'pyams_content.shared.news.manager.NewsManager'>), ('forms', <class 'pyams_content.shared.form.manager.FormsManager'>), ('imagemaps', <class 'pyams_content.shared.imagemap.manager.ImageMapsManager'>)], registry=None)
-

Create required shared tools

-
- -
-
-pyams_content.generations.get_tools_manager(site, config, registry=None)
-

Check for shared tools manager

-
- -
-
-pyams_content.generations.handle_new_local_site(event)
-

Check for required utilities when a site is created

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.html --- a/src/build/html/pyams_content.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,678 +0,0 @@ - - - - - - - pyams_content package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content package

-
-

Subpackages

-
- -
-
-
-

Submodules

-
-
-

pyams_content.include module

-
-
-pyams_content.include.include_package(config)
-

Pyramid include

-
- -
-
-

pyams_content.site module

-
-
-class pyams_content.site.BaseGenerationsChecker
-

Bases: object

-

PyAMS base generations checker

-
-
-evolve(site, current=None)
-

Check for required utilities

-
- -
-
-generation = 1
-
- -
- -
-
-pyams_content.site.handle_new_local_site(event)
-

Create a new IntIds when a site is created

-
- -
-
-pyams_content.site.site_index(request)
-

Index all site contents in internal catalog

-
- -
-
-

Module contents

-
-
-pyams_content.includeme(config)
-

Pyramid include

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.profile.html --- a/src/build/html/pyams_content.profile.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,167 +0,0 @@ - - - - - - - pyams_content.profile package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.profile package

- -
-

Submodules

-
-
-

pyams_content.profile.admin module

-
-
-class pyams_content.profile.admin.AdminProfile
-

Bases: persistent.Persistent

-

Admin profile persistent class

-
-
-favorites
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-table_page_length
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_content.profile.admin.AdminProfileFactory(context)
-
- -
-
-pyams_content.profile.admin.PrincipalAdminProfileFactory(principal)
-

Principal admin profile factory adapter

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.root.html --- a/src/build/html/pyams_content.root.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,272 +0,0 @@ - - - - - - - pyams_content.root package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.root package

- -
-

Module contents

-
-
-class pyams_content.root.SiteRoot
-

Bases: pyams_security.security.ProtectedObject, pyams_utils.site.BaseSiteRoot, pyams_skin.skin.UserSkinnableContent

-

Main site root

-
-
-managers
-

Custom field property used to handle role principals

-
- -
-
-operators
-

Custom field property used to handle role principals

-
- -
-
-roles_interface = <InterfaceClass pyams_content.root.interfaces.ISiteRootRoles>
-
- -
-
-templates_managers
-

Custom field property used to handle role principals

-
- -
-
-webmasters
-

Custom field property used to handle role principals

-
- -
- -
-
-class pyams_content.root.SiteRootBackOfficeConfiguration
-

Bases: pyams_skin.configuration.BackOfficeConfiguration

-

Site root back-office configuration

-
- -
-
-pyams_content.root.SiteRootBackOfficeConfigurationFactory(context)
-
- -
-
-class pyams_content.root.SiteRootConfiguration
-

Bases: pyams_skin.configuration.Configuration

-

Site root configuration

-
- -
-
-pyams_content.root.SiteRootConfigurationFactory(context)
-
- -
-
-class pyams_content.root.SiteRootPermissionChecker(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Site root permission checker

-
-
-edit_permission
-
- -
- -
-
-class pyams_content.root.SiteRootStaticConfiguration(context, request, view)
-

Bases: pyams_skin.configuration.StaticConfiguration

-

Site root static configuration

-
-
-application_name = 'PyAMS CMS'
-
- -
-
-application_package = 'pyams_content'
-
- -
-
-include_reload_button = False
-
- -
-
-inner_package = 'pyams_skin'
-
- -
-
-inner_package_name = 'PyAMS'
-
- -
- -
-
-class pyams_content.root.SiteRootToolsConfiguration
-

Bases: persistent.Persistent

-

Site root tools configuration

-
-
-forms_tool_name = None
-
- -
-
-imagemaps_tool_name = None
-
- -
-
-news_tool_name = None
-
- -
-
-tools_name = None
-
- -
-
-views_tool_name = None
-
- -
- -
-
-pyams_content.root.handle_granted_role(event)
-

Add principals to operators group when a role is granted

-
- -
-
-pyams_content.root.site_root_tools_configuration_factory(context)
-

Site root tools configuration factory

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.shared.common.zmi.html --- a/src/build/html/pyams_content.shared.common.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,3932 +0,0 @@ - - - - - - - pyams_content.shared.common.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.shared.common.zmi package

-
-

Submodules

-
-
-

pyams_content.shared.common.zmi.dashboard module

-
-
-class pyams_content.shared.common.zmi.dashboard.BaseDashboardTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Base dashboard table

-
-
-data_attributes
-
- -
-
-dt_sort_order = 'desc'
-
- -
-
-sortOn = None
-
- -
-
-title
-
- -
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.FavoritesColumnAddRemoveColumn(context, request, table)
-

Bases: pyams_skin.table.JsActionColumn

-

Favorites column add/remove column

-
-
-cssClasses = {'td': 'action switcher', 'th': 'action'}
-
- -
-
-get_icon(item)
-
- -
-
-get_url(item)
-
- -
-
-icon_class = 'fa fa-fw fa-star'
-
- -
-
-icon_hint = 'Add/remove from favorites'
-
- -
-
-url = 'PyAMS_content.profile.switchFavorite'
-
- -
-
-weight = 1
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllContentsMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool ‘all contents’ dashboard menu

-
-
-icon_class = 'fa-pencil-square'
-
- -
-
-label = 'Other interventions'
-
- -
-
-url = '#'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllPublicationsHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool published contents header adapter

-
-
-back_url = '#dashboard.html'
-
- -
-
-icon_class = 'fa fa-fw fa-pencil-square'
-
- -
-
-subtitle = 'Last published contents'
-
- -
-
-title
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllPublicationsMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool published contents dashboard menu

-
-
-icon_class = None
-
- -
-
-label = 'Last publications'
-
- -
-
-url = '#all-publications.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllPublicationsTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool published contents table

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllPublicationsValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool published contents values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllPublicationsView(context, request)
-

Bases: pyams_zmi.view.InnerAdminView, pyams_skin.container.ContainerView

-

Shared tool published contents view

-
-
-table_class
-

alias of SharedToolAllPublicationsTable

-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllUpdatesHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool updated contents header adapter

-
-
-back_url = '#dashboard.html'
-
- -
-
-icon_class = 'fa fa-fw fa-pencil-square'
-
- -
-
-subtitle = 'Last updated contents'
-
- -
-
-title
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllUpdatesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool updated contents dashboard menu

-
-
-icon_class = None
-
- -
-
-label = 'Last updates'
-
- -
-
-url = '#all-updates.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllUpdatesTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool updated contents table

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllUpdatesValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool updated contents values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolAllUpdatesView(context, request)
-

Bases: pyams_zmi.view.InnerAdminView, pyams_skin.container.ContainerView

-

Shared tool updated contents view

-
-
-table_class
-

alias of SharedToolAllUpdatesTable

-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolArchivedContentsHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool archived contents header adapter

-
-
-back_url = '#dashboard.html'
-
- -
-
-icon_class = 'fa fa-fw fa-user'
-
- -
-
-subtitle = 'Your archived contents'
-
- -
-
-title
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolArchivedContentsTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool archived contents table

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolArchivedContentsValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool archived contents values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolArchivedContentsView(context, request)
-

Bases: pyams_zmi.view.InnerAdminView, pyams_skin.container.ContainerView

-

Shared tool archived contents view

-
-
-table_class
-

alias of SharedToolArchivedContentsTable

-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolArchivedMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool archived contents dashboard menu

-
-
-icon_class = None
-
- -
-
-label = 'My archived contents'
-
- -
-
-url = '#my-archived-contents.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardContentNameAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool dashboard content name adapter

-
-
-name
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool properties header adapter

-
-
-back_target = None
-
- -
-
-back_url = '/admin#dashboard.html'
-
- -
-
-icon_class = 'fa fa-fw fa-line-chart'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardManagerWaitingTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool dashboard waiting table

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardManagerWaitingValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool dashboard waiting values adapter

-
-
-check_access(content)
-
- -
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool dashboard menu

-
-
-icon_class = 'fa-line-chart'
-
- -
-
-label = 'Dashboard'
-
- -
-
-url = '#dashboard.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardModifiedColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Shared tool dashboard modified column

-
-
-getValue(obj)
-
- -
-
-weight = 40
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardNameAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool dashboard name adapter

-
-
-name
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardNameColumn(context, request, table)
-

Bases: pyams_skin.table.NameColumn

-

Shared tool dashboard name column

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardOwnerColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Shared tool dashboard owner column

-
-
-cssClasses = {'td': 'col-xs-hide', 'th': 'col-xs-hide'}
-
- -
-
-getValue(obj)
-
- -
-
-weight = 35
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardOwnerModifiedTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool dashboard owned modified contents table

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardOwnerModifiedValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool dashboard waiting owned contents values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardOwnerWaitingTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool dashboard waiting owned contents table

-
-
-dt_sort_order = 'asc'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardOwnerWaitingValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool dashboard waiting owned contents values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardSequenceColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Shared tool dashboard sequence ID column

-
-
-getValue(obj)
-
- -
-
-weight = 15
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardStatusColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Shared tool dashboard status column

-
-
-getValue(obj)
-
- -
-
-weight = 20
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardStatusDateColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Shared tool dashboard status date column

-
-
-cssClasses = {'td': 'col-xs-hide col-sm-hide', 'th': 'col-xs-hide col-sm-hide'}
-
- -
-
-getValue(obj)
-
- -
-
-weight = 21
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardStatusPrincipalColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Shared tool dashboard status principal column

-
-
-cssClasses = {'td': 'col-xs-hide', 'th': 'col-xs-hide'}
-
- -
-
-getValue(obj)
-
- -
-
-weight = 30
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardVersionColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Shared tool dashboard version column

-
-
-getValue(obj)
-
- -
-
-weight = 25
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolDashboardView(context, request)
-

Bases: pyams_zmi.view.InnerAdminView

-

Shared tool dashboard view

-
-
-header_title
-
- -
-
-title = 'Contents dashboard'
-
- -
-
-update()
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolFavoritesHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool favorites header adapter

-
-
-back_url = '#dashboard.html'
-
- -
-
-icon_class = 'fa fa-fw fa-user'
-
- -
-
-subtitle = 'Your favorites'
-
- -
-
-title
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolFavoritesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool favorites dashboard menu

-
-
-icon_class = None
-
- -
-
-label = 'My favorites'
-
- -
-
-url = '#my-favorites.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolFavoritesTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool favorites table

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolFavoritesValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool favorites values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolFavoritesView(context, request)
-

Bases: pyams_zmi.view.InnerAdminView, pyams_skin.container.ContainerView

-

Shared tool favorites view

-
-
-table_class
-

alias of SharedToolFavoritesTable

-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolMyDashboardMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool ‘my contents’ dashboard menu

-
-
-icon_class = 'fa-user'
-
- -
-
-label = 'My contents'
-
- -
-
-url = '#'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolPreparationsHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool preparations header adapter

-
-
-back_url = '#dashboard.html'
-
- -
-
-icon_class = 'fa fa-fw fa-user'
-
- -
-
-subtitle = 'Your prepared contents'
-
- -
-
-title
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolPreparationsMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool preparations dashboard menu

-
-
-icon_class = None
-
- -
-
-label = 'My preparations'
-
- -
-
-url = '#my-preparations.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolPreparationsTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool preparations table

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolPreparationsValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool preparations values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolPreparationsView(context, request)
-

Bases: pyams_zmi.view.InnerAdminView, pyams_skin.container.ContainerView

-

Shared tool preparations view

-
-
-table_class
-

alias of SharedToolPreparationsTable

-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolPublicationsHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool publications header adapter

-
-
-back_url = '#dashboard.html'
-
- -
-
-icon_class = 'fa fa-fw fa-user'
-
- -
-
-subtitle = 'Your published contents'
-
- -
-
-title
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolPublicationsMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool publications dashboard menu

-
-
-icon_class = None
-
- -
-
-label = 'My publications'
-
- -
-
-url = '#my-publications.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolPublicationsTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool publications table

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolPublicationsValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool publications values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolPublicationsView(context, request)
-

Bases: pyams_zmi.view.InnerAdminView, pyams_skin.container.ContainerView

-

Shared tool publications view

-
-
-table_class
-

alias of SharedToolPublicationsTable

-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolRetiredContentsHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool retired contents header adapter

-
-
-back_url = '#dashboard.html'
-
- -
-
-icon_class = 'fa fa-fw fa-user'
-
- -
-
-subtitle = 'Your retired contents'
-
- -
-
-title
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolRetiredContentsTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool retired contents table

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolRetiredContentsValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool retired contents values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolRetiredContentsView(context, request)
-

Bases: pyams_zmi.view.InnerAdminView, pyams_skin.container.ContainerView

-

Shared tool retired contents view

-
-
-table_class
-

alias of SharedToolRetiredContentsTable

-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolRetiredMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool retired contents dashboard menu

-
-
-icon_class = None
-
- -
-
-label = 'My retired contents'
-
- -
-
-url = '#my-retired-contents.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolSubmissionsHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool submissions header adapter

-
-
-back_url = '#dashboard.html'
-
- -
-
-icon_class = 'fa fa-fw fa-user'
-
- -
-
-subtitle = 'Your submitted contents'
-
- -
-
-title
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolSubmissionsMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool submissions dashboard menu

-
-
-icon_class = None
-
- -
-
-label = 'My submissions'
-
- -
-
-url = '#my-submissions.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolSubmissionsTable(context, request)
-

Bases: pyams_content.shared.common.zmi.dashboard.BaseDashboardTable

-

Shared tool submissions table

-
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolSubmissionsValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool submissions values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.dashboard.SharedToolSubmissionsView(context, request)
-

Bases: pyams_zmi.view.InnerAdminView, pyams_skin.container.ContainerView

-

Shared tool submissions view

-
-
-table_class
-

alias of SharedToolSubmissionsTable

-
- -
- -
-
-

pyams_content.shared.common.zmi.header module

-
-
-class pyams_content.shared.common.zmi.header.SharedContentHeaderContentProvider(context, request, view)
-

Bases: object

-

Header for shared contents

-
-
-back_target = None
-
- -
-
-back_url = '#summary.html'
-
- -
-
-favorite_content
-
- -
-
-hex_oid
-
- -
-
-icon_class = ''
-
- -
-
-title
-
- -
- -
-
-class pyams_content.shared.common.zmi.header.SharedContentInnerPageHeaderContentProvider
-

Bases: object

-

Inner page header content provider

-
-
-render()
-
- -
-
-update()
-
- -
- -
-
-class pyams_content.shared.common.zmi.header.SharedContentTitlePrefixAdapter(context, request)
-

Bases: pyams_skin.site.ContextTitlePrefixAdapter

-

Shared content title prefix adapter

-
-
-prefix
-
- -
- -
-
-

pyams_content.shared.common.zmi.i18n module

-
-
-class pyams_content.shared.common.zmi.i18n.SharedContentLanguageEditFormPermissionChecker(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

I18n manager language edit form permission checker

-
-
-edit_permission = 'pyams.ManageContent'
-
- -
- -
-
-

pyams_content.shared.common.zmi.manager module

-
-
-class pyams_content.shared.common.zmi.manager.SharedToolBreadcrumbAdapter(context, request)
-

Bases: pyams_skin.viewlet.breadcrumb.BreadcrumbItem

-

Shared tool breadcrumb adapter

-
-
-css_class = 'strong'
-
- -
-
-label
-
- -
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolLanguagesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.shared.common.zmi.manager.SharedToolLanguagesEditForm

-

Shared tool languages edit form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolLanguagesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminEditForm

-

Shared tool languages edit form

-
-
-ajax_handler = 'languages.json'
-
- -
-
-edit_permission = 'pyams.ManageTool'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Content languages'
-
- -
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolLanguagesEditFormHelp(context, request, view)
-

Bases: pyams_form.help.FormHelp

-

Shared tool languages edit form help

-
-
-message = 'Tool languages are used to translate own tool properties, and newly created contents will propose these languages by default'
-
- -
-
-message_format = 'rest'
-
- -
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolLanguagesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool languages menu

-
-
-icon_class = 'fa-flag'
-
- -
-
-label = 'Languages'
-
- -
-
-url = '#languages.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.shared.common.zmi.manager.SharedToolPropertiesEditForm

-

Shared tool properties edit form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminEditForm

-

Shared tool properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageTool'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Shared tool properties'
-
- -
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolPropertiesHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool properties header adapter

-
-
-back_target = None
-
- -
-
-back_url = '/admin#properties.html'
-
- -
-
-icon_class = 'fa fa-fw fa-edit'
-
- -
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolPropertiesHelpAdapter(context, request, view)
-

Bases: pyams_form.help.FormHelp

-

Shared tool properties help adapter

-
-
-header = 'WARNING'
-
- -
-
-message = "Workflow shouldn't be modified if this tool already contains any shared content!"
-
- -
-
-message_format = 'rest'
-
- -
-
-permission = 'pyams.ManageTool'
-
- -
-
-status = 'danger'
-
- -
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolPropertiesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool properties menu

-
-
-icon_class = 'fa-edit'
-
- -
-
-label = 'Properties'
-
- -
-
-url = '#properties.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolSiteManagementMenuHeader(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

Shared tool site management menu header adapter

-
-
-header = 'Tool management'
-
- -
- -
-
-class pyams_content.shared.common.zmi.manager.SharedToolTitleAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool title adapter

-
-
-title
-
- -
- -
-
-

pyams_content.shared.common.zmi.owner module

-
-
-class pyams_content.shared.common.zmi.owner.WfSharedContentOwnerChangeAJAXForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.shared.common.zmi.owner.WfSharedContentOwnerChangeForm

-

Shared content owner change form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.common.zmi.owner.WfSharedContentOwnerChangeForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Shared content owner change form

-
-
-ajax_handler = 'change-owner.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
-
-createAndAdd(data)
-
- -
-
-edit_permission = 'pyams.ManageSite'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = "Change content's owner"
-
- -
-
-updateActions()
-
- -
- -
-
-class pyams_content.shared.common.zmi.owner.WfSharedContentOwnerChangeFormHelp(context, request, view)
-

Bases: pyams_form.help.FormHelp

-

Shared content owner change form help

-
-
-message = 'All versions of this content which are not archived will be transferred to newly selected owner'
-
- -
-
-message_format = 'rest'
-
- -
- -
-
-class pyams_content.shared.common.zmi.owner.WfSharedContentOwnerChangeMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared content owner change menu

-
-
-icon_class = 'fa fa-fw fa-user'
-
- -
-
-label = 'Change owner...'
-
- -
-
-modal_target = True
-
- -
-
-url = 'change-owner.html'
-
- -
- -
-
-

pyams_content.shared.common.zmi.properties module

-
-
-class pyams_content.shared.common.zmi.properties.SharedContentCompositionMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared content properties menu

-
-
-icon_class = 'fa-dropbox'
-
- -
-
-label = 'Composition'
-
- -
-
-url = '#summary.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.properties.SharedContentPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.shared.common.zmi.properties.SharedContentPropertiesEditForm

-

Shared content properties edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.common.zmi.properties.SharedContentPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminEditForm

-

Shared content properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Content properties'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.shared.common.zmi.properties.SharedContentPropertiesHeaderAdapter(context, request, view)
-

Bases: pyams_content.shared.common.zmi.WfSharedContentHeaderAdapter

-

Shared content properties header adapter

-
-
-icon_class = 'fa fa-fw fa-edit'
-
- -
- -
-
-class pyams_content.shared.common.zmi.properties.SharedContentPropertiesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared content properties menu

-
-
-icon_class = 'fa-edit'
-
- -
-
-label = 'Properties'
-
- -
-
-url = '#properties.html'
-
- -
- -
-
-

pyams_content.shared.common.zmi.search module

-
-
-class pyams_content.shared.common.zmi.search.SearchResultsViewValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Search results view values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.search.SharedToolAdvancedSearchForm(context, request)
-

Bases: pyams_form.search.SearchForm

-

Shared tool advanced search form

-
-
-ajax_handler = 'advanced-search-results.html'
-
- -
-
-fields
-
- -
-
-legend = 'Advanced search'
-
- -
- -
-
-class pyams_content.shared.common.zmi.search.SharedToolAdvancedSearchFormSearchAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool adavanced search form search adapter

-
-
-get_search_results(data)
-
- -
- -
-
-class pyams_content.shared.common.zmi.search.SharedToolAdvancedSearchHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool advanced search header adapter

-
-
-back_target = None
-
- -
-
-back_url = '#dashboard.html'
-
- -
-
-icon_class = 'fa fa-fw fa-search'
-
- -
- -
-
-class pyams_content.shared.common.zmi.search.SharedToolAdvancedSearchMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool advanced search menu

-
-
-icon_class = None
-
- -
-
-label = 'Advanced search'
-
- -
-
-url = '#advanced-search.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.search.SharedToolAdvancedSearchResultsView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_form.search.SearchResultsView

-

Shared tool advanced search results view

-
-
-data_attributes
-
- -
-
-search_form_factory
-

alias of SharedToolAdvancedSearchForm

-
- -
-
-sortOn = None
-
- -
-
-title = 'Advanced search results'
-
- -
- -
-
-class pyams_content.shared.common.zmi.search.SharedToolAdvancedSearchView
-

Bases: pyams_form.search.SearchView

-

Shared tool advanced search view

-
-
-search_form_factory
-

alias of SharedToolAdvancedSearchForm

-
- -
- -
-
-class pyams_content.shared.common.zmi.search.SharedToolQuickSearchResults(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Shared tool quick search results table

-
-
-data_attributes
-
- -
-
-sortOn = None
-
- -
-
-title = 'Quick search results'
-
- -
- -
-
-class pyams_content.shared.common.zmi.search.SharedToolQuickSearchValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool quick search results view values adapter

-
-
-values
-
- -
- -
-
-pyams_content.shared.common.zmi.search.shared_tool_quick_search_view(request)
-

Shared tool quick search view

-
- -
-
-

pyams_content.shared.common.zmi.security module

-
-
-class pyams_content.shared.common.zmi.security.PrincipalInfoElementEditor(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Principal info element editor

-
-
-modal_target = True
-
- -
-
-url
-
- -
-
-view_name = 'manager-restrictions.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.security.SharedToolManagerRestrictionsAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.shared.common.zmi.security.SharedToolManagerRestrictionsEditForm

-

Shared tool manager restrictions edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.common.zmi.security.SharedToolManagerRestrictionsEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Shared tool manager restrictions edit form

-
-
-ajax_handler = 'manager-restrictions.json'
-
- -
-
-edit_permission = 'pyams.ManageTool'
-
- -
-
-fields
-
- -
-
-getContent()
-
- -
-
-icon_css_class = 'fa fa-fw fa-lock'
-
- -
-
-interface
-
- -
-
-legend
-
- -
-
-principal
-
- -
-
-principal_id
-
- -
-
-update()
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.shared.common.zmi.security.SharedToolManagerRestrictionsEnabledColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Shared tool manager enabled restrictions column

-
-
-cssClasses = {'td': 'center'}
-
- -
-
-getValue(obj)
-
- -
-
-weight = 45
-
- -
- -
-
-class pyams_content.shared.common.zmi.security.SharedToolManagerRestrictionsNameColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Shared tool manager restrictions name column

-
-
-attrName = 'title'
-
- -
-
-weight = 10
-
- -
- -
-
-class pyams_content.shared.common.zmi.security.SharedToolManagerRestrictionsOwnersColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Shared tool manager owners restrictions column

-
-
-cssClasses = {'td': 'center'}
-
- -
-
-getValue(obj)
-
- -
-
-weight = 50
-
- -
- -
-
-class pyams_content.shared.common.zmi.security.SharedToolManagerRestrictionsValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared tool manager restrictions values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.security.SharedToolManagersRestrictionsHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared tool managers restrictions header adapter

-
-
-back_target = None
-
- -
-
-back_url = 'admin#protected-object-roles.html'
-
- -
-
-icon_class = 'fa fa-fw fa-lock'
-
- -
- -
-
-class pyams_content.shared.common.zmi.security.SharedToolManagersRestrictionsMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Shared tool managers restrictions menu

-
-
-icon_class = 'fa-lock'
-
- -
-
-label = 'Managers restrictions'
-
- -
-
-url = '#managers-restrictions.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.security.SharedToolManagersRestrictionsTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Shared tool manager restrictions table

-
-
-id = 'security_manager_restrictions'
-
- -
-
-title = 'Content managers restrictions'
-
- -
- -
-
-class pyams_content.shared.common.zmi.security.SharedToolManagersRestrictionsView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

-

Shared tool managers restrictions view

-
-
-table_class
-

alias of SharedToolManagersRestrictionsTable

-
- -
- -
-
-

pyams_content.shared.common.zmi.site module

-
-
-class pyams_content.shared.common.zmi.site.SharedSiteDashboardSearchHeaderAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Site manager dashboard search header adapter

-
-
-title
-
- -
- -
-
-

pyams_content.shared.common.zmi.summary module

-
-
-class pyams_content.shared.common.zmi.summary.SharedContentDublinCoreSummary(context, request, view=None)
-

Bases: pyams_zmi.form.InnerAdminDisplayForm

-

Shared content DublinCore summary

-
-
-css_class = 'form-tight'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-tab_label = 'Identity card'
-
- -
-
-weight = 1
-
- -
- -
-
-class pyams_content.shared.common.zmi.summary.SharedContentSummaryForm(context, request)
-

Bases: pyams_zmi.form.AdminDisplayForm

-

Shared content summary form

-
-
-css_class = 'ams-form form-horizontal form-tight'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Display content summary'
-
- -
- -
-
-class pyams_content.shared.common.zmi.summary.SharedContentSummaryFormHeaderProvider(context, request, view)
-

Bases: pyams_content.shared.common.zmi.header.SharedContentHeaderContentProvider

-

Shared content summary form header provider

-
-
-back_url
-
- -
- -
-
-class pyams_content.shared.common.zmi.summary.SharedContentWorkflowHistorySummary(context, request, view=None)
-

Bases: pyams_zmi.form.InnerAdminDisplayForm

-

Shared content workflow history summary

-
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Content history'
-
- -
-
-updateWidgets(prefix=None)
-
- -
-
-weight = 40
-
- -
- -
-
-class pyams_content.shared.common.zmi.summary.SharedContentWorkflowPublicationState(context, request, view=None)
-

Bases: pyams_zmi.form.InnerAdminDisplayForm

-

Shared content workflow publication state summary

-
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Publication and retire dates'
-
- -
-
-weight = 20
-
- -
- -
-
-class pyams_content.shared.common.zmi.summary.SharedContentWorkflowVersionSummary(context, request, view=None)
-

Bases: pyams_zmi.form.InnerAdminDisplayForm

-

Shared content workflow version summary

-
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Current version'
-
- -
-
-updateWidgets(prefix=None)
-
- -
-
-weight = 30
-
- -
- -
-
-class pyams_content.shared.common.zmi.summary.SharedContentWorkflowWaitingState(context, request, view=None)
-

Bases: pyams_zmi.form.InnerAdminAddForm

-

Shared content workflow waiting state summary

-
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Requested action'
-
- -
-
-mode = 'display'
-
- -
-
-updateWidgets(prefix=None)
-
- -
-
-weight = 10
-
- -
- -
-
-

pyams_content.shared.common.zmi.types module

-
-
-class pyams_content.shared.common.zmi.types.DataSubtypeAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.shared.common.zmi.types.DataSubtypeAddForm

-

Data subtype add form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DataSubtypeAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.shared.common.zmi.types.DataSubtypeEditForm

-

Data subtype edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DataSubtypeAddAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Data subtype adding action

-
-
-label = 'Add subtype'
-
- -
-
-label_css_class = 'fa fa-fw fa-plus'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-data-subtype.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DataSubtypeAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Data subtype add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-data-subtype.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageTool'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-folder-o'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Add new subtype'
-
- -
-
-nextURL()
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DataSubtypeEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Data subtype edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageTool'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-folder-o'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Data subtype properties'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DataTypeAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.shared.common.zmi.types.DataTypeAddForm

-

Data type add form, JSON renderer

-
-
-nextURL()
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DataTypeAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.shared.common.zmi.types.DataTypeEditForm

-

Data type edit form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.types.DataTypeAddAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Data type adding action

-
-
-label = 'Add data type'
-
- -
-
-label_css_class = 'fa fa-fw fa-plus'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-data-type.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DataTypeAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Data type add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-data-type.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageTool'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-folder-o'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Add new data type'
-
- -
-
-nextURL()
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DataTypeEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Data type edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageTool'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-folder-o'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Data type properties'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DataTypeElementNameAdapter(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

Types shared tool types name adapter

-
-
-name
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DatatypeSubtypesTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Data type subtypes table

-
-
-cssClasses = {'table': 'table table-bordered table-striped table-hover table-tight table-dnd'}
-
- -
-
-data_attributes
-
- -
-
-hide_header = True
-
- -
-
-id
-
- -
-
-sortOn = None
-
- -
-
-values
-
- -
-
-widget_class = 'ams-widget margin-top-5'
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DatatypeSubtypesTableAssociationsColumn(context, request, table)
-

Bases: pyams_skin.table.ActionColumn

-

Data type subtypes associations column

-
-
-icon_class = 'fa fa-fw fa-link'
-
- -
-
-icon_hint = 'Default associations'
-
- -
-
-modal_target = True
-
- -
-
-permission = 'pyams.ManageTool'
-
- -
-
-url = 'associations-dialog.html'
-
- -
-
-weight = 110
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DatatypeSubtypesTableNameColumn(context, request, table)
-

Bases: pyams_skin.table.NameColumn

-

Data type subtypes table name column

-
-
-renderHeadCell()
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DatatypeSubtypesTableParagraphsColumn(context, request, table)
-

Bases: pyams_skin.table.ActionColumn

-

Data type subtypes paragraphs column

-
-
-icon_class = 'fa fa-fw fa-paragraph'
-
- -
-
-icon_hint = 'Default paragraphs'
-
- -
-
-modal_target = True
-
- -
-
-permission = 'pyams.ManageTool'
-
- -
-
-url = 'paragraphs-dialog.html'
-
- -
-
-weight = 100
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DatatypeSubtypesTableSorterColumn(context, request, table)
-

Bases: pyams_skin.table.SorterColumn

-

Data type subtypes table sorter column

-
- -
-
-class pyams_content.shared.common.zmi.types.DatatypeSubtypesTableTrashColumn(context, request, table)
-

Bases: pyams_skin.table.TrashColumn

-

Data type subtypes table trash column

-
-
-permission = 'pyams.ManageTool'
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.DatatypeSubtypesTableValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Data type subtypes table values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.TypedSharedToolTypesAssociationsColumn(context, request, table)
-

Bases: pyams_skin.table.ActionColumn

-

Typed shared tool types associations column

-
-
-icon_class = 'fa fa-fw fa-link'
-
- -
-
-icon_hint = 'Default associations'
-
- -
-
-modal_target = True
-
- -
-
-permission = 'pyams.ManageTool'
-
- -
-
-url = 'associations-dialog.html'
-
- -
-
-weight = 110
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.TypedSharedToolTypesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Typed shared tool types menu

-
-
-icon_class = 'fa-folder-o'
-
- -
-
-label = 'Data types'
-
- -
-
-url = '#data-types.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.TypedSharedToolTypesNameColumn(context, request, table)
-

Bases: pyams_skin.table.NameColumn

-

Typed shared tool types name column

-
-
-renderCell(item)
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.TypedSharedToolTypesParagraphsColumn(context, request, table)
-

Bases: pyams_skin.table.ActionColumn

-

Typed shared tool types paragraphs column

-
-
-icon_class = 'fa fa-fw fa-paragraph'
-
- -
-
-icon_hint = 'Default paragraphs'
-
- -
-
-modal_target = True
-
- -
-
-permission = 'pyams.ManageTool'
-
- -
-
-url = 'paragraphs-dialog.html'
-
- -
-
-weight = 100
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.TypedSharedToolTypesSorterColumn(context, request, table)
-

Bases: pyams_form.security.ProtectedFormObjectMixin, pyams_skin.table.SorterColumn

-

Typed shared tool types sorter column

-
- -
-
-class pyams_content.shared.common.zmi.types.TypedSharedToolTypesTable(context, request)
-

Bases: pyams_form.security.ProtectedFormObjectMixin, pyams_skin.table.BaseTable

-

Typed shared tool types table

-
-
-cssClasses
-
- -
-
-data_attributes
-
- -
-
-hide_header = True
-
- -
-
-id = 'types_list'
-
- -
-
-render()
-
- -
-
-sortOn = None
-
- -
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.TypedSharedToolTypesTrashColumn(context, request, table)
-

Bases: pyams_skin.table.TrashColumn

-

Typed shared tool types trash column

-
-
-permission = 'pyams.ManageTool'
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.TypedSharedToolTypesValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Typed shared tool types table values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.common.zmi.types.TypedSharedToolTypesView(context, request)
-

Bases: pyams_zmi.view.ContainerAdminView

-

Typed shared tool types view

-
-
-table_class
-

alias of TypedSharedToolTypesTable

-
- -
-
-title = 'Content data types'
-
- -
- -
-
-pyams_content.shared.common.zmi.types.delete_data_type(request)
-

Data type delete view

-
- -
-
-pyams_content.shared.common.zmi.types.delete_subtype(request)
-

Data subtype delete view

-
- -
-
-pyams_content.shared.common.zmi.types.get_subtypes_table(request)
-

Get subtypes table

-
- -
-
-pyams_content.shared.common.zmi.types.handle_datatype_add_form_data_extraction(event)
-

Check new data type for existing name

-
- -
-
-pyams_content.shared.common.zmi.types.handle_subtype_add_form_data_extraction(event)
-

Check new data subtype for existing name

-
- -
-
-pyams_content.shared.common.zmi.types.set_data_types_order(request)
-

Update data types order

-
- -
-
-pyams_content.shared.common.zmi.types.set_subtypes_order(request)
-

Update subtypes order

-
- -
-
-

pyams_content.shared.common.zmi.workflow module

-
-
-class pyams_content.shared.common.zmi.workflow.PublicationAJAXForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionAJAXForm, pyams_content.shared.common.zmi.workflow.PublicationForm

-

Shared content publication form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveAJAXForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionAJAXForm, pyams_content.shared.common.zmi.workflow.PublicationArchiveForm

-

Shared content publication archive form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveCancelAJAXForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionAJAXForm, pyams_content.shared.common.zmi.workflow.PublicationArchiveCancelForm

-

Shared content publication archive request cancel form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveCancelForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content publication archive request cancel form

-
-
-ajax_handler = 'wf-cancel-archiving.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveCancelFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication archive cancel form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveCancelFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication archive cancel form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content publication archive form

-
-
-ajax_handler = 'wf-archive.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication archive form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication archive form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveRequestAJAXForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionAJAXForm, pyams_content.shared.common.zmi.workflow.PublicationArchiveRequestForm

-

Shared content publication archive request form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveRequestForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content publication request archive form

-
-
-ajax_handler = 'wf-archiving.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveRequestFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication archive request form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationArchiveRequestFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication archive request form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content publication form

-
-
-ajax_handler = 'wf-publish.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
-
-createAndAdd(data)
-
- -
-
-fields
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Shared content publication form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Shared content publication form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestAJAXForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionAJAXForm, pyams_content.shared.common.zmi.workflow.PublicationRequestForm

-

Shared content publication request form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestCancelAJAXForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionAJAXForm, pyams_content.shared.common.zmi.workflow.PublicationRequestCancelForm

-

Shared content publication request cancel form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestCancelForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content publication request cancel form

-
-
-ajax_handler = 'wf-cancel-propose.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestCancelFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication request cancel form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestCancelFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication request cancel form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content publication request form

-
-
-ajax_handler = 'wf-propose.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
-
-createAndAdd(data)
-
- -
-
-fields
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication request form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication request form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestRefuseAJAXForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionAJAXForm, pyams_content.shared.common.zmi.workflow.PublicationRequestRefuseForm

-

Shared content publication request refuse form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestRefuseForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content publication request refuse form

-
-
-ajax_handler = 'wf-refuse.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestRefuseFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication request refuse form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRequestRefuseFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication request refuse form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireAJAXForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionAJAXForm, pyams_content.shared.common.zmi.workflow.PublicationRetireForm

-

Shared content publication retire form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireCancelAJAXForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionAJAXForm, pyams_content.shared.common.zmi.workflow.PublicationRetireCancelForm

-

Shared content publication retire request cancel form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireCancelForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content publication retire request cancel form

-
-
-ajax_handler = 'wf-cancel-retiring.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireCancelFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication retire request form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireCancelFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication retire request cancel form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content publication retire form

-
-
-ajax_handler = 'wf-retire.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication retire form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication retire form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireRequestAJAXForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionAJAXForm, pyams_content.shared.common.zmi.workflow.PublicationRetireRequestForm

-

Shared content publication retire request form, JSON renderer

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireRequestForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content publication request refuse form

-
-
-ajax_handler = 'wf-retiring.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireRequestFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication retire request form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.PublicationRetireRequestFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication retire request form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.SharedContentCloneAJAXForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.shared.common.zmi.workflow.SharedContentCloneForm

-

Shared content clone form, JSON rendener

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.SharedContentCloneForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content clone form

-
-
-ajax_handler = 'wf-clone.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
-
-createAndAdd(data)
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.SharedContentCloneFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Shared content clone form info message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.SharedContentCloneFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Shared content clone form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.SharedContentDeleteAJAXForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.shared.common.zmi.workflow.SharedContentDeleteForm

-

Shared content delete form, JSON rendener

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.SharedContentDeleteForm(context, request)
-

Bases: pyams_workflow.zmi.transition.WorkflowContentTransitionForm

-

Shared content delete form

-
-
-ajax_handler = 'wf-delete.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
-
-createAndAdd(data)
-
- -
-
-fields
-
- -
-
-legend
-
- -
-
-updateActions()
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.SharedContentDeleteFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Shared content delete form info message

-
-
-version_id
-
- -
- -
-
-class pyams_content.shared.common.zmi.workflow.SharedContentDeleteFormWarning(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Shared content delete form warning message

-
- -
-
-class pyams_content.shared.common.zmi.workflow.WorkflowContentTransitionFormInfo(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Publication request form info message

-
-
-next_step
-
- -
-
-previous_message
-
- -
-
-previous_step
-
- -
- -
-
-pyams_content.shared.common.zmi.workflow.handle_publication_form_data_extraction(event)
-

Handle publication form data extraction

-
- -
-
-pyams_content.shared.common.zmi.workflow.handle_publication_request_form_data_extraction(event)
-

Handle publication request form data extraction

-
- -
-
-pyams_content.shared.common.zmi.workflow.handle_publication_request_refuse_form_data_extraction(event)
-

Handle publication request refuse form data extraction

-
- -
-
-pyams_content.shared.common.zmi.workflow.handle_publication_retire_request_form_data_extraction(event)
-

Handle publication retire request form data extraction

-
- -
-
-

Module contents

-
-
-class pyams_content.shared.common.zmi.SharedContentAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm

-

Shared event add form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.common.zmi.SharedContentAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Shared content add form

-
-
-add(wf_content)
-
- -
-
-ajax_handler = 'add-shared-content.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.CreateContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-plus'
-
- -
-
-nextURL()
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
-
-update_content(content, data)
-
- -
- -
-
-class pyams_content.shared.common.zmi.SharedContentAddFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Shared content add form info message

-
- -
-
-class pyams_content.shared.common.zmi.WfModifiedContentColumnMixin
-

Bases: object

-

Shared content modified column mixin

-
-
-renderCell(item)
-
- -
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentBreadcrumbAdapter(context, request)
-

Bases: pyams_skin.viewlet.breadcrumb.BreadcrumbItem

-

Shared content breadcrumb adapter

-
-
-label
-
- -
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentDuplicateAJAXForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.shared.common.zmi.WfSharedContentDuplicateForm

-

Shared content duplicate form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentDuplicateForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Shared content duplicate form

-
-
-ajax_handler = 'duplicate.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
-
-createAndAdd(data)
-
- -
-
-edit_permission = 'pyams.CreateContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-files-o'
-
- -
-
-legend = 'Duplicate content'
-
- -
-
-updateActions()
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentDuplicateFormMessage(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Shared content add form info message

-
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentDuplicateMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Shared content duplication menu item

-
-
-label = 'Duplicate content...'
-
- -
-
-label_css_class = 'fa fa-fw fa-files-o'
-
- -
-
-modal_target = True
-
- -
-
-url = 'duplicate.html'
-
- -
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentDuplicationMenuDivider(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuDivider

-

Shared content duplication menu divider

-
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentElementEditor(context, request, view)
-

Bases: pyams_skin.table.DefaultElementEditorAdapter

-

Shared content element editor

-
-
-modal_target = False
-
- -
-
-view_name = 'admin'
-
- -
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Shared content header adapter

-
-
-back_target = None
-
- -
-
-back_url
-
- -
-
-icon_class = 'fa fa-fw fa-edit'
-
- -
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentPermissionChecker(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Shared content form permission checker

-
-
-edit_permission
-
- -
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentPermissionMixin
-

Bases: object

-

Shared content permission checker

-
-
-permission
-
- -
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentSiteManagementMenuHeader(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

Shared content site management menu header adapter

-
-
-header = ' '
-
- -
- -
-
-class pyams_content.shared.common.zmi.WfSharedContentTitleAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared content title adapter

-
-
-title
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.shared.imagemap.zmi.html --- a/src/build/html/pyams_content.shared.imagemap.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,683 +0,0 @@ - - - - - - - pyams_content.shared.imagemap.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.shared.imagemap.zmi package

-
-

Submodules

-
-
-

pyams_content.shared.imagemap.zmi.area module

-
-
-class pyams_content.shared.imagemap.zmi.area.ImagemapAreaAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.shared.imagemap.zmi.area.ImagemapAreaAddForm

-

Image map area add form, JSON renderer

-
- -
-
-class pyams_content.shared.imagemap.zmi.area.ImagemapAreaAddAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Image map area add menu

-
-
-label = 'Add image area'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-area.html'
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.area.ImagemapAreaAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Imagemap area add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-area.json'
-
- -
-
-create(data)
-
- -
-
-dialog_class
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Add new image area'
-
- -
-
-nextURL()
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.area.ImagemapAreaPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.shared.imagemap.zmi.area.ImagemapAreaPropertiesEditForm

-

Image map properties edit form, JSON rendener

-
- -
-
-class pyams_content.shared.imagemap.zmi.area.ImagemapAreaPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Image map area properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-dialog_class
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Edit image map properties'
-
- -
- -
-
-

pyams_content.shared.imagemap.zmi.container module

-
-
-class pyams_content.shared.imagemap.zmi.container.ImagemapAreasContainerNameColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, pyams_content.shared.common.zmi.WfModifiedContentColumnMixin, z3c.table.column.GetAttrColumn

-

Image map areas container name column

-
-
-getValue(obj)
-
- -
-
-weight = 10
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.container.ImagemapAreasContainerTargetColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Image map areas container target URL column

-
-
-getValue(obj)
-
- -
-
-weight = 20
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.container.ImagemapAreasContainerTrashColumn(context, request, table)
-

Bases: pyams_form.security.ProtectedFormObjectMixin, pyams_skin.table.TrashColumn

-

Image map areas container trash column

-
- -
-
-class pyams_content.shared.imagemap.zmi.container.ImagemapAreasContainerView(context, request)
-

Bases: pyams_zmi.view.AdminView

-

Image map areas container view

-
-
-title = 'Image map areas'
-
- -
-
-update()
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.container.ImagemapAreasMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Image map areas menu

-
-
-icon_class = 'fa-location-arrow'
-
- -
-
-label = 'Image areas'
-
- -
-
-url = '#areas.html'
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.container.ImagemapAreasTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Image map areas table

-
-
-cssClasses = {'table': 'table table-bordered table-striped table-hover table-tight'}
-
- -
-
-data_attributes
-
- -
-
-hide_header = True
-
- -
-
-render()
-
- -
-
-values
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.container.ImagemapAreasValues(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Image map areas caontainer values

-
-
-values
-
- -
- -
-
-pyams_content.shared.imagemap.zmi.container.delete_imagemap_area(request)
-

Delete image map area

-
- -
-
-

pyams_content.shared.imagemap.zmi.paragraph module

-
-
-class pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagrahPropertiesAJAXEditForm(context, request)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphAJAXEditForm, pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphPropertiesEditForm

-

Image map properties edit form, JSON renderer

-
- -
-
-class pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphAJAXAddForm(context, request)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphAJAXAddForm, pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphAddForm

-

Image map paragraph add form, JSON renderer

-
- -
-
-class pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Image map paragraph add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-imagemap-paragraph.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-location-arrow'
-
- -
-
-legend = 'Add new image map'
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphAddMenu(context, request, view, manager)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphAddMenu

-

Image map paragraph add menu

-
-
-label = 'Add image map...'
-
- -
-
-label_css_class = 'fa fa-fw fa-location-arrow'
-
- -
-
-paragraph_type = 'ImageMap'
-
- -
-
-url = 'add-imagemap-paragraph.html'
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphInnerAJAXEditForm(context, request)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphAJAXEditForm, pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphInnerEditForm

-

Image map paragraph properties inner edit form, JSON rendener

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphInnerEditForm(context, request)
-

Bases: pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphPropertiesEditForm

-

Image map properties inner edit form

-
-
-ajax_handler = 'inner-properties.json'
-
- -
-
-buttons
-
- -
-
-legend = None
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphPreviewWidgetsSuffix(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Image map paragraph preview widgets suffix

-
- -
-
-class pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphPropertiesEditForm(context, request)
-

Bases: pyams_content.component.paragraph.zmi.BaseParagraphPropertiesEditForm

-

Image map paragraph edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-location-arrow'
-
- -
-
-legend = 'Edit paragraph properties'
-
- -
-
-title
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.paragraph.ImagemapParagraphSummary(context, request)
-

Bases: pyams_viewlet.viewlet.BaseContentProvider

-

Image map paragraph summary

-
-
-get_item_info(item)
-
- -
-
-language = None
-
- -
- -
-
-

pyams_content.shared.imagemap.zmi.preview module

-
-
-class pyams_content.shared.imagemap.zmi.preview.ImagemapPreview
-

Bases: object

-

Image map preview

-
-
-get_item_info(item)
-
- -
- -
-
-

pyams_content.shared.imagemap.zmi.properties module

-
-
-class pyams_content.shared.imagemap.zmi.properties.ImageMapPropertiesEditForm(context, request, view=None)
-

Bases: pyams_zmi.form.InnerAdminEditForm

-

Image map properties edit form extension

-
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-fieldset_class = 'bordered no-x-margin margin-y-10'
-
- -
-
-get_ajax_output(changes)
-
- -
-
-legend = 'Background image'
-
- -
-
-weight = 10
-
- -
- -
-
-

pyams_content.shared.imagemap.zmi.widget module

-
-
-pyams_content.shared.imagemap.zmi.widget.ImgareaInputFieldWidget(field, request)
-

Image map area input widget factory

-
- -
-
-class pyams_content.shared.imagemap.zmi.widget.ImgareaInputWidget(request)
-

Bases: z3c.form.browser.text.TextWidget

-

Image map area input widget

-
-
-image_url
-
- -
- -
-
-

Module contents

-
-
-class pyams_content.shared.imagemap.zmi.ImageMapAJAXAddForm(context, request)
-

Bases: pyams_content.shared.common.zmi.SharedContentAJAXAddForm, pyams_content.shared.imagemap.zmi.ImageMapAddForm

-

Image map add form, JSON renderer

-
- -
-
-class pyams_content.shared.imagemap.zmi.ImageMapAddAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Image map adding action

-
-
-label = 'Add image map'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-shared-content.html'
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.ImageMapAddForm(context, request)
-

Bases: pyams_content.shared.common.zmi.SharedContentAddForm

-

Image map add form

-
-
-legend = 'Adding image map'
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.ImageMapContentMenuHeader(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

Image map content menu header adapter

-
-
-header = 'This image map'
-
- -
- -
-
-class pyams_content.shared.imagemap.zmi.ImageMapTitleAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Image map title adapter

-
-
-title
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.shared.site.html --- a/src/build/html/pyams_content.shared.site.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,425 +0,0 @@ - - - - - - - pyams_content.shared.site package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.shared.site package

- -
-

Submodules

-
-
-

pyams_content.shared.site.container module

-
-
-class pyams_content.shared.site.container.SiteContainerMixin
-

Bases: object

-

Site container mixin class

-
-
-get_folders_tree(selected=None, permission=None)
-
- -
- -
-
-

pyams_content.shared.site.folder module

-
-
-class pyams_content.shared.site.folder.SiteFolder
-

Bases: pyams_content.shared.site.container.SiteContainerMixin, zope.container.ordered.OrderedContainer, pyams_content.shared.common.manager.BaseSharedTool

-

Site folder persistent class

-
-
-is_deletable()
-
- -
-
-notepad
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-roles_interface = <InterfaceClass pyams_content.shared.site.interfaces.ISiteFolderRoles>
-
- -
-
-sequence_name = ''
-
- -
-
-sequence_prefix = ''
-
- -
- -
-
-class pyams_content.shared.site.folder.SiteFolderPermissionChecker(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Site folder edit permission checker

-
-
-edit_permission = 'pyams.ManageSite'
-
- -
- -
-
-class pyams_content.shared.site.folder.SiteManagerFoldersVocabulary(context)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

Site manager folders vocabulary

-
- -
- -
-

pyams_content.shared.site.manager module

-
-
-class pyams_content.shared.site.manager.SiteManager
-

Bases: pyams_content.shared.site.container.SiteContainerMixin, zope.container.ordered.OrderedContainer, pyams_content.shared.common.manager.BaseSharedTool, pyams_skin.skin.UserSkinnableContent

-

Site manager persistent class

-
-
-allowed_paragraphs
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-auto_created_paragraphs
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-folder_factory
-

alias of SiteFolder

-
- -
-
-is_deletable()
-
- -
-
-sequence_name = ''
-
- -
-
-sequence_prefix = ''
-
- -
-
-topic_content_factory
-

alias of Topic

-
- -
-
-topic_content_type = 'topic'
-
- -
- -
-
-class pyams_content.shared.site.manager.SiteManagerPermissionChecker(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Site manager edit permission checker

-
-
-edit_permission = 'pyams.ManageSite'
-
- -
- -
-
-class pyams_content.shared.site.manager.SiteManagerVocabulary(context)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

Site manager vocabulary

-
-
-interface = <InterfaceClass pyams_content.shared.site.interfaces.ISiteManager>
-
- -
- -
-
-pyams_content.shared.site.manager.handle_added_site_manager(event)
-

Register site manager when added

-
- -
-
-pyams_content.shared.site.manager.handle_deleted_site_manager(event)
-

Un-register site manager when deleted

-
- -
-
-

Module contents

-
-
-class pyams_content.shared.site.Topic
-

Bases: pyams_content.shared.common.SharedContent

-

WOrkflow managed topic class

-
-
-content_class
-

alias of WfTopic

-
- -
-
-is_deletable()
-
- -
- -
-
-class pyams_content.shared.site.WfTopic
-

Bases: pyams_content.shared.common.WfSharedContent

-

Base topic

-
-
-content_name = 'Topic'
-
- -
-
-content_type = 'topic'
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.shared.site.zmi.html --- a/src/build/html/pyams_content.shared.site.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1108 +0,0 @@ - - - - - - - pyams_content.shared.site.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.shared.site.zmi package

- -
-

Submodules

-
-
-

pyams_content.shared.site.zmi.container module

-
-
-class pyams_content.shared.site.zmi.container.SharedContentTableElementEditor(context, request, view)
-

Bases: pyams_skin.table.DefaultElementEditorAdapter

-

Shared content tree table element editor

-
-
-modal_target = False
-
- -
-
-url
-
- -
-
-view_name = 'admin'
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SharedContentTableElementName(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Shared content tree table element name

-
-
-name
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerBreadcrumbAdapter(context, request)
-

Bases: pyams_skin.viewlet.breadcrumb.BreadcrumbItem

-

Site container breadcrumb adapter

-
-
-label
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTableElementEditor(context, request, view)
-

Bases: pyams_skin.table.DefaultElementEditorAdapter

-

Site container tree table element editor

-
-
-modal_target = False
-
- -
-
-view_name = 'admin#site-tree.html'
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTableElementName(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Site container tree table element name

-
-
-name
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTableItemWorkflowPublicationMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Site container tree item workflow publication menu

-
-
-label = 'Publication dates...'
-
- -
-
-label_css_class = 'fa fa-fw fa-eye'
-
- -
-
-modal_target = True
-
- -
-
-stop_propagation = True
-
- -
-
-url = 'workflow-publication.html'
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Site container tree menu

-
-
-icon_class = 'fa-sitemap'
-
- -
-
-label = 'Site tree'
-
- -
-
-url = '#site-tree.html'
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeNameColumn(context, request, table)
-

Bases: pyams_skin.table.NameColumn

-

Site container tree name column

-
-
-renderCell(item, name=None)
-
- -
-
-renderHeadCell()
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeOwnerColumn(context, request, table)
-

Bases: pyams_content.shared.common.zmi.dashboard.SharedToolDashboardOwnerColumn

-

Site container tree owner column

-
-
-cssClasses = {'td': 'col-xs-hide', 'th': 'col-xs-hide'}
-
- -
-
-getValue(obj)
-
- -
-
-weight = 35
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeSequenceColumn(context, request, table)
-

Bases: pyams_content.shared.common.zmi.dashboard.SharedToolDashboardSequenceColumn

-

Site container tree OID column

-
-
-getValue(obj)
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeSorterColumn(context, request, table)
-

Bases: pyams_skin.table.SorterColumn

-

Site container tree sorter column

-
-
-permission = 'pyams.ManageSite'
-
- -
-
-renderCell(item)
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeStatusColumn(context, request, table)
-

Bases: pyams_content.shared.common.zmi.dashboard.SharedToolDashboardStatusColumn

-

Site container tree status column

-
-
-getValue(obj)
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeStatusDateColumn(context, request, table)
-

Bases: pyams_content.shared.common.zmi.dashboard.SharedToolDashboardStatusDateColumn

-

Site container tree status date column

-
-
-getValue(obj)
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeStatusPrincipalColumn(context, request, table)
-

Bases: pyams_content.shared.common.zmi.dashboard.SharedToolDashboardStatusPrincipalColumn

-

Site container tree status principal column

-
-
-getValue(obj)
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeTable(context, request, can_sort=False, rows_state=None)
-

Bases: pyams_skin.table.BaseTable

-

Site container tree table

-
-
-cssClasses
-
- -
-
-data_attributes
-
- -
-
-hide_body_toolbar = True
-
- -
-
-id = 'site_tree_table'
-
- -
-
-permission = 'pyams.ManageSite'
-
- -
-
-sortOn = None
-
- -
-
-title = 'Site tree'
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeTrashColumn(context, request, table)
-

Bases: pyams_skin.table.TrashColumn

-

Site container tree trash column

-
-
-has_permission(item)
-
- -
-
-icon_hint = 'Delete site item'
-
- -
-
-permission = 'pyams.ManageSite'
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Site container tree values adapter

-
-
-values
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeVersionColumn(context, request, table)
-

Bases: pyams_content.shared.common.zmi.dashboard.SharedToolDashboardVersionColumn

-

Site container tree version column

-
-
-getValue(obj)
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

-

Site Container tree view

-
-
-table_class
-

alias of SiteContainerTreeTable

-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerTreeVisibleColumn(context, request, table)
-

Bases: pyams_skin.table.JsActionColumn

-

Site container tree visible column

-
-
-cssClasses = {'td': 'action', 'th': 'action'}
-
- -
-
-get_icon(item)
-
- -
-
-icon_class = 'fa fa-fw fa-eye'
-
- -
-
-icon_hint = 'Visible element?'
-
- -
-
-permission = 'pyams.ManageContent'
-
- -
-
-renderCell(item)
-
- -
-
-url = 'PyAMS_content.site.switchVisibility'
-
- -
-
-weight = 5
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerViewHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Site container tree view header adapter

-
-
-icon_class = 'fa fa-fw fa-sitemap'
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerWorkflowPublicationAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.shared.site.zmi.container.SiteContainerWorkflowPublicationEditForm

-

Site container workflow publication edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerWorkflowPublicationEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Site container workflow publication edit form

-
-
-ajax_handler = 'workflow-publication.json'
-
- -
-
-edit_permission = 'pyams.ManageSite'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Update publication dates'
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteContainerWorkflowPublicationMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Site container workflow publication menu

-
-
-icon_class = 'fa-eye'
-
- -
-
-label = 'Publication dates...'
-
- -
-
-modal_target = True
-
- -
-
-url = 'workflow-publication.html'
-
- -
- -
-
-class pyams_content.shared.site.zmi.container.SiteManagerUserAddingsMenuLabelAdapter(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

Site container user adding menu label adapter

-
-
-label
-
- -
- -
-
-pyams_content.shared.site.zmi.container.delete_site_item(request)
-

Delete item from site container

-
- -
-
-pyams_content.shared.site.zmi.container.get_tree(request)
-

Get whole tree

-
- -
-
-pyams_content.shared.site.zmi.container.get_tree_nodes(request)
-

Get tree nodes

-
- -
-
-pyams_content.shared.site.zmi.container.set_content_visibility(request)
-

Set content link visibility

-
- -
-
-pyams_content.shared.site.zmi.container.set_site_order(request)
-

Set site elements order

-
- -
-
-

pyams_content.shared.site.zmi.folder module

-
-
-class pyams_content.shared.site.zmi.folder.SiteFolderAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.shared.site.zmi.folder.SiteFolderAddForm

-

Site folder add form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content.shared.site.zmi.folder.SiteFolderAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Site folder add form

-
-
-add(content)
-
- -
-
-ajax_handler = 'add-site-folder.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageSite'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-folder-o'
-
- -
-
-legend = 'Add site folder'
-
- -
-
-nextURL()
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
-
-update_content(content, data)
-
- -
- -
-
-class pyams_content.shared.site.zmi.folder.SiteFolderAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Site folder add menu

-
-
-label = 'Add site folder...'
-
- -
-
-label_css_class = 'fa fa-fw fa-folder-o'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-site-folder.html'
-
- -
- -
-
-pyams_content.shared.site.zmi.folder.handle_site_folder_add_form_data_extraction(event)
-

Handle site folder add form data extraction

-
- -
- -
-

pyams_content.shared.site.zmi.manager module

-
-
-class pyams_content.shared.site.zmi.manager.SiteManagerAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.shared.site.zmi.manager.SiteManagerAddForm

-

Site manager add form, JSOn renderer

-
- -
-
-class pyams_content.shared.site.zmi.manager.SiteManagerAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Site manager add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-site-manager.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = None
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-sitemap'
-
- -
-
-legend = 'Add site manager'
-
- -
-
-nextURL()
-
- -
-
-title = 'Site manager'
-
- -
- -
-
-class pyams_content.shared.site.zmi.manager.SiteManagerAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Site manager add menu

-
-
-label = 'Add site manager'
-
- -
-
-label_css_class = 'fa fa-fw fa-sitemap'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-site-manager.html'
-
- -
- -
-
-class pyams_content.shared.site.zmi.manager.SiteManagerBreadcrumbAdapter(context, request)
-

Bases: pyams_skin.viewlet.breadcrumb.BreadcrumbItem

-

Site manager breadcrumb adapter

-
-
-css_class = 'strong'
-
- -
-
-label
-
- -
- -
-
-class pyams_content.shared.site.zmi.manager.SiteManagerTableElementEditor(context, request, view)
-

Bases: pyams_skin.table.DefaultElementEditorAdapter

-

Site tree table element editor

-
-
-modal_target = False
-
- -
-
-view_name = 'admin#site-tree.html'
-
- -
- -
-
-class pyams_content.shared.site.zmi.manager.SiteManagerUserAddingsMenuLabelAdapter(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

Site manager user addings menu label adapter

-
-
-label
-
- -
- -
-
-pyams_content.shared.site.zmi.manager.handle_new_site_manager_data_extraction(event)
-

Handle new site manager data extraction

-
- -
-
-

Module contents

-
-
-class pyams_content.shared.site.zmi.TopicAJAXAddForm(context, request)
-

Bases: pyams_content.shared.common.zmi.SharedContentAJAXAddForm, pyams_content.shared.site.zmi.TopicAddForm

-

Topic add form, JSON renderer

-
- -
-
-class pyams_content.shared.site.zmi.TopicAddForm(context, request)
-

Bases: pyams_content.shared.common.zmi.SharedContentAddForm

-

Topic add form

-
-
-add(content)
-
- -
-
-ajax_handler = 'add-topic.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.CreateContent'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Add topic'
-
- -
-
-nextURL()
-
- -
-
-updateWidgets(prefix=None)
-
- -
-
-update_content(content, data)
-
- -
- -
-
-class pyams_content.shared.site.zmi.TopicAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Topic add menu

-
-
-label = 'Add topic...'
-
- -
-
-label_css_class = 'fa fa-fw fa-file-o'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-topic.html'
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.shared.view.portlet.html --- a/src/build/html/pyams_content.shared.view.portlet.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,197 +0,0 @@ - - - - - - - pyams_content.shared.view.portlet package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.shared.view.portlet package

- -
-

Submodules

-
-
-

pyams_content.shared.view.portlet.interfaces module

-
-
-

Module contents

-
-
-class pyams_content.shared.view.portlet.ViewItemsPortlet
-

Bases: pyams_portal.portlet.Portlet

-

View items portlet

-
-
-label = 'View items'
-
- -
-
-name = 'pyams_content.portlet.view'
-
- -
-
-settings_class
-

alias of ViewItemsPortletSettings

-
- -
-
-toolbar_css_class = 'fa fa-fw fa-2x fa-th-list'
-
- -
-
-toolbar_image = None
-
- -
- -
-
-class pyams_content.shared.view.portlet.ViewItemsPortletRenderer(context, request, view, settings)
-

Bases: pyams_portal.portlet.PortletRenderer

-

View items portlet renderer

-
-
-label = 'Simple list view'
-
- -
- -
-
-class pyams_content.shared.view.portlet.ViewItemsPortletSettings(configuration)
-

Bases: pyams_portal.portlet.PortletSettings

-

View items portlet settings

-
-
-get_items(context)
-
- -
-
-get_view()
-
- -
-
-view
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.shared.view.portlet.zmi.html --- a/src/build/html/pyams_content.shared.view.portlet.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,131 +0,0 @@ - - - - - - - pyams_content.shared.view.portlet.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.shared.view.portlet.zmi package

-
-

Module contents

-
-
-class pyams_content.shared.view.portlet.zmi.ViewItemsPortletPreviewer(context, request, view, settings)
-

Bases: pyams_portal.portlet.PortletPreviewer

-

Image portlet previewer

-
- -
-
-class pyams_content.shared.view.portlet.zmi.ViewItemsPortletSettingsAJAXEditor(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content.shared.view.portlet.zmi.ViewItemsPortletSettingsEditor

-

View items portlet settings editor, JSON renderer

-
- -
-
-class pyams_content.shared.view.portlet.zmi.ViewItemsPortletSettingsEditor(context, request)
-

Bases: pyams_portal.zmi.portlet.PortletSettingsEditor

-

View items portlet settings editor

-
-
-settings = <InterfaceClass pyams_content.shared.view.portlet.interfaces.IViewItemsPortletSettings>
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.skin.html --- a/src/build/html/pyams_content.skin.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,119 +0,0 @@ - - - - - - - pyams_content.skin package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.skin package

-
-

Submodules

-
-
-

pyams_content.skin.routes module

-
-
-pyams_content.skin.routes.get_oid_access(request)
-

Get direct access to given OID

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.tests.html --- a/src/build/html/pyams_content.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_content.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.tests package

-
-

Submodules

-
-
-

pyams_content.tests.test_utilsdocs module

-

Generic Test case for pyams_content doctest

-
-
-pyams_content.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_content.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_content.tests.test_utilsdocstrings module

-

Generic Test case for pyams_content doc strings

-
-
-pyams_content.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_content.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.workflow.zmi.html --- a/src/build/html/pyams_content.workflow.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,175 +0,0 @@ - - - - - - - pyams_content.workflow.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.workflow.zmi package

-
-

Submodules

-
-
-

pyams_content.workflow.zmi.task module

-
-
-class pyams_content.workflow.zmi.task.ContentArchiverTaskAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content.workflow.zmi.task.ContentArchiverTaskAddForm

-

Content archiver task add form, JSON renderer

-
- -
-
-class pyams_content.workflow.zmi.task.ContentArchiverTaskAddForm(context, request)
-

Bases: pyams_scheduler.zmi.task.TaskBaseAddForm

-

Content archiver task add form

-
-
-ajax_handler = 'add-content-archiver-task.json'
-
- -
-
-icon_css_class = 'fa fa-fw fa-archive'
-
- -
-
-legend = 'Add automatic content archiver'
-
- -
-
-task_factory
-

alias of ContentArchiverTask

-
- -
- -
-
-class pyams_content.workflow.zmi.task.ContentArchiverTaskAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Content archiver task add menu

-
-
-label = 'Add content archiver task...'
-
- -
-
-label_css_class = 'fa fa-fw fa-archive'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-content-archiver-task.html'
-
- -
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.zmi.html --- a/src/build/html/pyams_content.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,148 +0,0 @@ - - - - - - - pyams_content.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.zmi package

- -
-

Submodules

-
-
-

pyams_content.zmi.tinymce module

-
-
-class pyams_content.zmi.tinymce.TinyMCEEditorConfiguration(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

TinyMCE editor configuration

-
-
-configuration
-
- -
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content.zmi.viewlet.html --- a/src/build/html/pyams_content.zmi.viewlet.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,117 +0,0 @@ - - - - - - - pyams_content.zmi.viewlet package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content.zmi.viewlet package

- -
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content_es.component.html --- a/src/build/html/pyams_content_es.component.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,233 +0,0 @@ - - - - - - - pyams_content_es.component package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content_es.component package

-
-

Submodules

-
-
-

pyams_content_es.component.extfile module

-
-
-pyams_content_es.component.extfile.ParagraphContainerTargetExtFileIndexInfo(context)
-

External files index info

-
- -
-
-

pyams_content_es.component.gallery module

-
-
-pyams_content_es.component.gallery.GalleryIndexInfo(gallery)
-

Gallery index info

-
- -
-
-pyams_content_es.component.gallery.GalleryTargetIndexInfo(content)
-

Gallery container index info

-
- -
-
-

pyams_content_es.component.paragraph module

-
-
-pyams_content_es.component.paragraph.GalleryParagraphIndexInfo(paragraph)
-

Gallery paragraph index info

-
- -
-
-pyams_content_es.component.paragraph.HTMLParagraphIndexInfo(paragraph)
-

HTML paragraph index info

-
- -
-
-pyams_content_es.component.paragraph.HeaderParagraphIndexInfo(paragraph)
-

Header paragraph index info

-
- -
-
-pyams_content_es.component.paragraph.IllustrationIndexInfo(paragraph)
-

Illustration index info

-
- -
-
-pyams_content_es.component.paragraph.ImagemapParagraphIndexInfo(paragraph)
-

Image map paragraph index info

-
- -
-
-pyams_content_es.component.paragraph.ParagraphContainerTargetIndexInfo(content)
-

Paragraph container index info

-
- -
-
-

pyams_content_es.component.theme module

-
-
-pyams_content_es.component.theme.ThemesTargetIndexInfo(content)
-

Themes target index info

-
- -
-
-class pyams_content_es.component.theme.ViewThemesQueryEsParamsExtension(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

View themes query adapter

-
-
-get_es_params(context)
-
- -
-
-weight = 60
-
- -
- -
-
-

pyams_content_es.component.view module

-
-
-class pyams_content_es.component.view.EsViewQuery(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

View query for Elasticsearch

-
-
-get_es_params(context)
-
- -
-
-get_results(context, limit=None)
-
- -
- -
-
-

pyams_content_es.component.workflow module

-
-
-pyams_content_es.component.workflow.WorkflowManagedContentIndexInfo(content)
-

Workflow managed content index info

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content_es.interfaces.html --- a/src/build/html/pyams_content_es.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_content_es.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content_es.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_content_es.zmi.html --- a/src/build/html/pyams_content_es.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,270 +0,0 @@ - - - - - - - pyams_content_es.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_content_es.zmi package

-
-

Submodules

-
-
-

pyams_content_es.zmi.test module

-
-
-pyams_content_es.zmi.test.es_test_view(context, request)
-
- -
-
-

Module contents

-
-
-class pyams_content_es.zmi.ContentIndexerProcessAJAXTestForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_content_es.zmi.ContentIndexerProcessTestForm

-

Content indexer process test form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_content_es.zmi.ContentIndexerProcessTestForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Content indexer process test form

-
-
-ajax_handler = 'test-indexer-process.json'
-
- -
-
-buttons = <z3c.form.button.Buttons object>
-
- -
-
-createAndAdd(data)
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-form_target
-
- -
-
-icon_css_class = 'fa fa-fw fa-server'
-
- -
-
-legend = 'Test content indexer process connection'
-
- -
-
-prefix = 'test_form.'
-
- -
-
-title
-
- -
-
-updateActions()
-
- -
- -
-
-class pyams_content_es.zmi.ContentIndexerProcessTestMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Content indexer process test menu

-
-
-label = 'Test process connection...'
-
- -
-
-label_css_class = 'fa fa-fw fa-server'
-
- -
-
-modal_target = True
-
- -
-
-stop_propagation = True
-
- -
-
-url = 'test-indexer-process.html'
-
- -
- -
-
-class pyams_content_es.zmi.ContentIndexerProcessTestSuffix(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Content indexer process test form suffix

-
- -
-
-class pyams_content_es.zmi.ContentIndexerUtilityPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_content_es.zmi.ContentIndexerUtilityPropertiesEditForm

-

Content index utility properties edit form, JSON renderer

-
- -
-
-class pyams_content_es.zmi.ContentIndexerUtilityPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Content indexer utility properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Update content indexer properties'
-
- -
-
-title
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_gis.rpc.json.html --- a/src/build/html/pyams_gis.rpc.json.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,151 +0,0 @@ - - - - - - - pyams_gis.rpc.json package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_gis.rpc.json package

-
-

Module contents

-
-
-pyams_gis.rpc.json.transformArea(request, area, from_projection, to_projection)
-

Transform area given in source projection to another projection

- --- - - - - - -
Parameters:
    -
  • area – area coordinates given as a mapping with ‘x1’, ‘y1’, ‘x2’, and ‘y2’ values
    • -
  • from_projection – source coordinates system given as SRID
    • -
  • to_projection – target coordinates system given as SRID
    • -
-
Returns:

mapping with new ‘area’ key containing transformed coordinates, and ‘projection’ -key containing SRID of result projection system

-
-
- -
-
-pyams_gis.rpc.json.transformPoint(request, point, from_projection, to_projection)
-

Transform point given in source projection to another projection

- --- - - - - - -
Parameters:
    -
  • point – point coordinates given as a mapping with ‘longitude’ and ‘latitude’ values
    • -
  • from_projection – source coordinates system given as SRID
    • -
  • to_projection – target coordinates system given as SRID
    • -
-
Returns:

mapping with new ‘point’ key containing transformed coordinates, and ‘projection’ -key containing SRID of result projection system

-
-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_gis.tests.html --- a/src/build/html/pyams_gis.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_gis.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_gis.tests package

-
-

Submodules

-
-
-

pyams_gis.tests.test_utilsdocs module

-

Generic Test case for pyams_gis doctest

-
-
-pyams_gis.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_gis.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_gis.tests.test_utilsdocstrings module

-

Generic Test case for pyams_gis doc strings

-
-
-pyams_gis.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_gis.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_gis.widget.html --- a/src/build/html/pyams_gis.widget.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,207 +0,0 @@ - - - - - - - pyams_gis.widget package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_gis.widget package

-
-

Submodules

-
-
-

pyams_gis.widget.area module

-
-
-pyams_gis.widget.area.GeoAreaFieldWidget(field, request)
-

GeoArea field widget factory

-
- -
-
-class pyams_gis.widget.area.GeoAreaObjectFactory(context, request, form, widget)
-

Bases: object

-

GeoArea object factory

-
- -
-
-class pyams_gis.widget.area.GeoAreaWidget(request)
-

Bases: z3c.form.browser.object.ObjectWidget

-

GeoArea widget

-
-
-updateWidgets(setErrors=True)
-
- -
-
-wgs_coordinates
-
- -
- -
-
-

pyams_gis.widget.point module

-
-
-pyams_gis.widget.point.GeoPointFieldWidget(field, request)
-

GeoPoint field widget factory

-
- -
-
-class pyams_gis.widget.point.GeoPointObjectFactory(context, request, form, widget)
-

Bases: object

-

GeoPointZ object factory

-
- -
-
-class pyams_gis.widget.point.GeoPointWidget(request)
-

Bases: z3c.form.browser.object.ObjectWidget

-

GeoPoint widget

-
-
-updateWidgets(setErrors=True)
-
- -
-
-wgs_coordinates
-
- -
- -
-
-pyams_gis.widget.point.GeoPointZFieldWidget(field, request)
-

GeoPointZ field widget factory

-
- -
-
-class pyams_gis.widget.point.GeoPointZObjectFactory(context, request, form, widget)
-

Bases: object

-

GeoPointZ object factory

-
- -
-
-class pyams_gis.widget.point.GeoPointZWidget(request)
-

Bases: z3c.form.browser.object.ObjectWidget

-

GeoPointZ widget

-
-
-updateWidgets(setErrors=True)
-
- -
-
-wgs_coordinates
-
- -
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_i18n.widget.html --- a/src/build/html/pyams_i18n.widget.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,224 +0,0 @@ - - - - - - - pyams_i18n.widget package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_i18n.widget package

-
-

Module contents

-
-
-class pyams_i18n.widget.I18nDataConverter(field, widget)
-

Bases: z3c.form.converter.BaseDataConverter

-

I18n base data converter

-
-
-toFieldValue(value)
-
- -
-
-toWidgetValue(value)
-
- -
- -
-
-pyams_i18n.widget.I18nFileFieldWidget(field, request)
-

I18n file field widget factory

-
- -
-
-class pyams_i18n.widget.I18nFileWidget(request)
-

Bases: pyams_i18n.widget.I18nWidget

-

I18n file widget

-
- -
-
-pyams_i18n.widget.I18nHTMLFieldWidget(field, request)
-

I18n HTML field widget factory

-
- -
-
-class pyams_i18n.widget.I18nHTMLWidget(request)
-

Bases: pyams_i18n.widget.I18nWidget

-

I18n HTML widget

-
- -
-
-pyams_i18n.widget.I18nSEOTextLineFieldWidget(field, request)
-

I18n text line field widget with SEO quality marker factory

-
- -
-
-class pyams_i18n.widget.I18nSEOTextLineWidget(request)
-

Bases: pyams_i18n.widget.I18nTextLineWidget

-

I18n text line widget with SEO quality marker

-
- -
-
-pyams_i18n.widget.I18nTextFieldWidget(field, request)
-

I18n text field widget factory

-
- -
-
-pyams_i18n.widget.I18nTextLineFieldWidget(field, request)
-

I18n text line field widget factory

-
- -
-
-class pyams_i18n.widget.I18nTextLineWidget(request)
-

Bases: pyams_i18n.widget.I18nWidget

-

I18n text line widget

-
- -
-
-class pyams_i18n.widget.I18nTextWidget(request)
-

Bases: pyams_i18n.widget.I18nWidget

-

I18n text widget

-
- -
-
-class pyams_i18n.widget.I18nWidget(request)
-

Bases: z3c.form.browser.widget.HTMLInputWidget, z3c.form.widget.Widget

-

I18n base widget

-
-
-extract(default=<NO_VALUE>)
-
- -
-
-get_value(lang)
-
- -
-
-get_widget(lang)
-
- -
-
-langs
-
- -
-
-update()
-
- -
-
-widget_factory = None
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_ldap.tests.html --- a/src/build/html/pyams_ldap.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_ldap.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_ldap.tests package

-
-

Submodules

-
-
-

pyams_ldap.tests.test_utilsdocs module

-

Generic Test case for pyams_ldap doctest

-
-
-pyams_ldap.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_ldap.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_ldap.tests.test_utilsdocstrings module

-

Generic Test case for pyams_ldap doc strings

-
-
-pyams_ldap.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_ldap.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_mail.interfaces.html --- a/src/build/html/pyams_mail.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_mail.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_mail.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_media.interfaces.html --- a/src/build/html/pyams_media.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_media.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_media.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_media.skin.html --- a/src/build/html/pyams_media.skin.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_media.skin package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_media.skin package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_notify.tests.html --- a/src/build/html/pyams_notify.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_notify.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_notify.tests package

-
-

Submodules

-
-
-

pyams_notify.tests.test_utilsdocs module

-

Generic Test case for pyams_notify doctest

-
-
-pyams_notify.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_notify.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_notify.tests.test_utilsdocstrings module

-

Generic Test case for pyams_notify doc strings

-
-
-pyams_notify.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_notify.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_notify.viewlet.html --- a/src/build/html/pyams_notify.viewlet.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,142 +0,0 @@ - - - - - - - pyams_notify.viewlet package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_notify.viewlet package

-
-

Module contents

-
-
-class pyams_notify.viewlet.NotificationsViewlet(context, request, view, manager)
-

Bases: pyams_skin.viewlet.activity.ActivityViewlet

-

Notifications viewlet

-
-
-cache_server
-
- -
-
-get_notifications()
-
- -
-
-label = 'Notifications'
-
- -
-
-name = 'notifications'
-
- -
-
-notify_server
-
- -
-
-url = 'PyAMS_notify.refreshNotifications'
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_pagelet.html --- a/src/build/html/pyams_pagelet.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,214 +0,0 @@ - - - - - - - PyAMS pagelets — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

PyAMS pagelets

-
-

Module contents

-
-
-pyams_pagelet.includeme(config)
-

Pyramid include

-
- -
- -
-

Submodules

-
-

pyams_pagelet.metaconfigure module

-
-
-pyams_pagelet.metaconfigure.PageletDirective(_context, name, view, context=<InterfaceClass zope.interface.Interface>, permission=None, layer=<InterfaceClass pyramid.interfaces.IRequest>, **kwargs)
-
- -
-
-

pyams_pagelet.metadirectives module

-
-
-

pyams_pagelet.pagelet module

-
-
-class pyams_pagelet.pagelet.Pagelet(context, request)
-

Bases: object

-

Content provider with layout support

-
-
-layout = None
-
- -
-
-permission = None
-
- -
-
-render()
-
- -
-
-template = None
-
- -
-
-update()
-
- -
- -
-
-class pyams_pagelet.pagelet.PageletRenderer(context, request, pagelet)
-

Bases: object

-

Pagelet renderer

-
-
-render()
-
- -
-
-update()
-
- -
- -
-
-class pyams_pagelet.pagelet.pagelet_config(**settings)
-

Bases: object

-

Function or class decorator used to declare a pagelet

-
-
-venusian = <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'>
-
- -
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_pagelet.interfaces.html --- a/src/build/html/pyams_pagelet.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,112 +0,0 @@ - - - - - - - pyams_pagelet.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_pagelet.interfaces package

-
-

Module contents

-
-
-class pyams_pagelet.interfaces.PageletCreatedEvent(object)
-

Bases: zope.interface.interfaces.ObjectEvent

-

Pagelet created event

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_portal.portlets.image.html --- a/src/build/html/pyams_portal.portlets.image.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,170 +0,0 @@ - - - - - - - pyams_portal.portlets.image package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_portal.portlets.image package

-
-

Submodules

-
-
-

pyams_portal.portlets.image.interfaces module

-
-
-

Module contents

-
-
-class pyams_portal.portlets.image.ImagePortlet
-

Bases: pyams_portal.portlet.Portlet

-

Image portlet

-
-
-label = 'Image'
-
- -
-
-name = 'pyams_portal.portlet.image'
-
- -
-
-settings_class
-

alias of ImagePortletSettings

-
- -
-
-toolbar_css_class = 'fa fa-fw fa-2x fa-picture-o'
-
- -
-
-toolbar_image = None
-
- -
- -
-
-class pyams_portal.portlets.image.ImagePortletRenderer(context, request, view, settings)
-

Bases: pyams_portal.portlet.PortletRenderer

-

Image portlet renderer

-
-
-label = 'Responsive image renderer'
-
- -
- -
-
-class pyams_portal.portlets.image.ImagePortletSettings(configuration)
-

Bases: pyams_portal.portlet.PortletSettings

-

Image portlet settings

-
-
-image
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_portal.tests.html --- a/src/build/html/pyams_portal.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_portal.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_portal.tests package

-
-

Submodules

-
-
-

pyams_portal.tests.test_utilsdocs module

-

Generic Test case for pyams_portal doctest

-
-
-pyams_portal.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_portal.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_portal.tests.test_utilsdocstrings module

-

Generic Test case for pyams_portal doc strings

-
-
-pyams_portal.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_portal.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_portal.zmi.html --- a/src/build/html/pyams_portal.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1216 +0,0 @@ - - - - - - - pyams_portal.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_portal.zmi package

- -
-

Submodules

-
-
-

pyams_portal.zmi.container module

-
-
-class pyams_portal.zmi.container.PortalTemplateContainerHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Portal template container header adapter

-
-
-icon_class = 'fa fa-fw fa-columns'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Portal template container menu

-
-
-icon_class = 'fa-columns'
-
- -
-
-label = 'Portal templates'
-
- -
-
-url = '#portal-templates.html'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerNameColumn(context, request, table)
-

Bases: pyams_skin.table.NameColumn

-

Portal template container name column

-
-
-attrName = 'name'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_portal.zmi.container.PortalTemplateContainerPropertiesEditForm

-

Portal template container properties edit form, JSON renderer

-
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Portal template container properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams_portal.manage_template'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-thumb-tack'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Edit selected portlets'
-
- -
-
-title = 'Portal templates container'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Portal template container table

-
-
-data_attributes
-
- -
-
-id = 'portal_templates_table'
-
- -
-
-title = 'Shared portal templates'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerTableElementEditor(context, request, view)
-

Bases: pyams_skin.table.DefaultElementEditorAdapter

-

Portal template container table element editor

-
-
-modal_target = False
-
- -
-
-url
-
- -
-
-view_name = 'portal-templates.html'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerTrashColumn(context, request, table)
-

Bases: pyams_skin.table.TrashColumn

-

Portal template container trash column

-
-
-icon_hint = 'Delete template'
-
- -
-
-permission = 'pyams_portal.manage_template'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Portal template container values adapter

-
-
-values
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

-

Portal template container view

-
-
-table_class
-

alias of PortalTemplateContainerTable

-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateTableElementEditor(context, request, view)
-

Bases: pyams_skin.table.DefaultElementEditorAdapter

-

Portal template table element editor

-
-
-modal_target = False
-
- -
-
-url
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplatesContainerPropertiesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Portal template container configuration menu

-
-
-get_url()
-
- -
-
-icon_class = 'fa-thumb-tack'
-
- -
-
-label = 'Selected portlets...'
-
- -
-
-modal_target = True
-
- -
-
-url = 'properties.html'
-
- -
- -
-
-

pyams_portal.zmi.interfaces module

-
-
-

pyams_portal.zmi.layout module

-
-
-class pyams_portal.zmi.layout.PortalTemplateAddMenuDivider(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuDivider

-

Portal template menu divider

-
- -
-
-class pyams_portal.zmi.layout.PortalTemplateLayoutHeaderAdapter(context, request, view)
-

Bases: pyams_portal.zmi.template.PortalTemplateHeaderAdapter

-

Portal template configuration header adapter

-
-
-back_target = None
-
- -
-
-back_url = '/admin#portal-templates.html'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateLayoutView
-

Bases: pyams_zmi.view.AdminView

-

Portal template main layout configuration view

-
-
-can_change
-
- -
-
-get_context()
-
- -
-
-get_portlet(name)
-
- -
-
-get_portlet_label(name)
-
- -
-
-get_portlet_preview(portlet_id)
-
- -
-
-get_template()
-
- -
-
-portlet_configuration
-
- -
-
-selected_portlets
-
- -
-
-template_configuration
-
- -
-
-title
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateMenuHeader(context, menu)
-

Bases: object

-

Portal template menu header

-
-
-header
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePortletAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_portal.zmi.layout.PortalTemplatePortletAddForm

-

Portal template portlet add form, AJAX handler

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePortletAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_portal.zmi.layout.PortalTemplatePortletEditForm

-

Portal template portlet edit form, AJAX renderer

-
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePortletAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Portal template portlet add form

-
-
-ajax_handler = 'add-template-portlet.json'
-
- -
-
-createAndAdd(data)
-
- -
-
-edit_permission = None
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-columns'
-
- -
-
-legend = 'Add portlet'
-
- -
-
-title
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePortletAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Portal template portlet add menu

-
-
-label = 'Add portlet...'
-
- -
-
-label_css_class = 'fa fa-fw fa-columns'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-template-portlet.html'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePortletEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Portal template portlet edit form

-
-
-dialog_class = 'modal-large'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePropertiesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Portal template properties menu

-
-
-icon_class = 'fa-edit'
-
- -
-
-label = 'Properties'
-
- -
-
-url = '#properties.html'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateRowAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.JsToolbarMenuItem

-

Portal template row add menu

-
-
-label = 'Add row...'
-
- -
-
-label_css_class = 'fa fa-fw fa-indent'
-
- -
-
-url = 'PyAMS_portal.template.addRow'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateSlotAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_portal.zmi.layout.PortalTemplateSlotAddForm

-

Portal template slot add form, AJAX handler

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateSlotAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Portal template slot add form

-
-
-ajax_handler = 'add-template-slot.json'
-
- -
-
-createAndAdd(data)
-
- -
-
-edit_permission = None
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-columns'
-
- -
-
-legend = 'Add slot'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateSlotAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Portal template slot add menu

-
-
-label = 'Add slot...'
-
- -
-
-label_css_class = 'fa fa-fw fa-columns'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-template-slot.html'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateSlotPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_portal.zmi.layout.PortalTemplateSlotPropertiesEditForm

-

Slot properties edit form, AJAX renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateSlotPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Slot properties edit form

-
-
-ajax_handler = 'slot-properties.json'
-
- -
-
-edit_permission = 'pyams_portal.manage_template'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-getContent()
-
- -
-
-input_css_class = 'col-md-7'
-
- -
-
-label_css_class = 'control-label col-md-5'
-
- -
-
-legend = 'Edit slot properties'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-pyams_portal.zmi.layout.add_template_row(request)
-

Add template raw

-
- -
-
-pyams_portal.zmi.layout.delete_template_portlet(request)
-

Delete template portlet

-
- -
-
-pyams_portal.zmi.layout.delete_template_row(request)
-

Delete template row

-
- -
-
-pyams_portal.zmi.layout.delete_template_slot(request)
-

Delete template slot

-
- -
-
-pyams_portal.zmi.layout.drag_template_portlet(request)
-

Drag portlet icon to slot

-
- -
-
-pyams_portal.zmi.layout.get_template_slots_width(request)
-

Get template slots width

-
- -
-
-pyams_portal.zmi.layout.handle_new_slot_data_extraction(event)
-

Handle new slot form data extraction

-
- -
-
-pyams_portal.zmi.layout.set_template_portlet_order(request)
-

Set template portlet order

-
- -
-
-pyams_portal.zmi.layout.set_template_row_order(request)
-

Set template rows order

-
- -
-
-pyams_portal.zmi.layout.set_template_slot_order(request)
-

Set template slots order

-
- -
-
-pyams_portal.zmi.layout.set_template_slot_width(request)
-

Set template slot width

-
- -
-
-

pyams_portal.zmi.page module

-
-
-class pyams_portal.zmi.page.PortalContextPropertiesEditFormHeaderAdapter(context, request, view)
-

Bases: pyams_zmi.site.PropertiesEditFormHeaderAdapter

-

Portal context template properties edit form header adapter

-
-
-icon_class = 'fa fa-fw fa-columns'
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextPropertiesEditFormHelpAdapter(context, request, view)
-

Bases: pyams_form.help.FormHelp

-

Portal context properties edit form help adapter

-
-
-message = "If you choose a shared template, you can only adjust settings of each portlet individually but can't change portlets list or page configuration.\nIf you use a local template, you can define a whole custom configuration but the template definition can't be reused anywhere..."
-
- -
-
-message_format = 'text'
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextTemplateConfigMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Portal context template configuration menu

-
-
-get_url()
-
- -
-
-label = 'Template properties'
-
- -
-
-url = '#template-config.html'
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextTemplateLayoutHeaderAdapter(context, request, view)
-

Bases: pyams_portal.zmi.template.PortalTemplateHeaderAdapter

-

Portal context template configuration header adapter

-
- -
-
-class pyams_portal.zmi.page.PortalContextTemplateLayoutView
-

Bases: pyams_portal.zmi.layout.PortalTemplateLayoutView

-

Portal context template configuration view

-
-
-can_change
-
- -
-
-get_template()
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextTemplatePortletAJAXEditForm(context, request)
-

Bases: pyams_portal.zmi.layout.PortalTemplatePortletAJAXEditForm

-

Portal context template portlet edit form, JSON renderer

-
- -
-
-class pyams_portal.zmi.page.PortalContextTemplatePortletEditForm(context, request)
-

Bases: pyams_portal.zmi.layout.PortalTemplatePortletEditForm

-

Portal context template portlet edit form

-
- -
-
-class pyams_portal.zmi.page.PortalContextTemplatePropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_portal.zmi.page.PortalContextTemplatePropertiesEditForm

-

Portal context template properties edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextTemplatePropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminEditForm

-

Portal context template properties edit form

-
-
-ajax_handler = 'template-properties.json'
-
- -
-
-edit_permission = 'pyams_portal.manage_template'
-
- -
-
-fields
-
- -
-
-getContent()
-
- -
-
-legend = 'Edit template configuration'
-
- -
-
-title
-
- -
-
-update()
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextTemplatePropertiesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Portal context template properties menu

-
-
-icon_class = 'fa-columns'
-
- -
-
-label = 'Presentation'
-
- -
-
-url = '#template-properties.html'
-
- -
- -
-
-pyams_portal.zmi.page.get_template_slots_width(request)
-

Get template slots width

-
- -
-
-

pyams_portal.zmi.portlet module

-
-
-class pyams_portal.zmi.portlet.PortletSettingsEditor(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Portlet settings edit form

-
-
-configuration
-
- -
-
-dialog_class = 'modal-large'
-
- -
-
-edit_permission = 'pyams_portal.manage_template'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-get_ajax_handler()
-
- -
-
-get_form_action()
-
- -
-
-legend = 'Edit portlet settings'
-
- -
-
-override_label
-
- -
-
-portlet
-
- -
-
-settings = None
-
- -
-
-title
-
- -
- -
-
-class pyams_portal.zmi.portlet.PortletSettingsPropertiesEditor(context, request, view=None)
-

Bases: pyams_zmi.form.InnerAdminEditForm

-

Portlet settings properties editor

-
-
-edit_permission = 'pyams_portal.manage_template'
-
- -
-
-fields
-
- -
-
-id = 'properties_form'
-
- -
-
-legend = None
-
- -
-
-tab_label = 'Main properties'
-
- -
-
-weight = 10
-
- -
- -
-
-

pyams_portal.zmi.template module

-
-
-class pyams_portal.zmi.template.PortalTemplateAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_portal.zmi.template.PortalTemplateAddForm

-

Portal template add form, AJAX handler

-
- -
-
-class pyams_portal.zmi.template.PortalTemplateAddAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Portal template add action

-
-
-label = 'Add template'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-portal-template.html'
-
- -
- -
-
-class pyams_portal.zmi.template.PortalTemplateAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Portal template add form

-
-
-add(template)
-
- -
-
-ajax_handler = 'add-portal-template.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = None
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-columns'
-
- -
-
-legend = 'Add shared template'
-
- -
-
-nextURL()
-
- -
-
-title = 'Portal templates'
-
- -
- -
-
-class pyams_portal.zmi.template.PortalTemplateHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Portal template header adapter

-
-
-icon_class = 'fa fa-fw fa-columns'
-
- -
-
-title
-
- -
- -
-
-pyams_portal.zmi.template.delete_portal_template(request)
-

Delete template from portal

-
- -
-
-pyams_portal.zmi.template.handle_new_template_data_extraction(event)
-

Handle new template form data extraction

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_portal.zmi.portlets.html --- a/src/build/html/pyams_portal.zmi.portlets.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,169 +0,0 @@ - - - - - - - pyams_portal.zmi.portlets package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_portal.zmi.portlets package

-
-

Submodules

-
-
-

pyams_portal.zmi.portlets.content module

-
-
-class pyams_portal.zmi.portlets.content.ContentPortletConfigurationAJAXEditor(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_portal.zmi.portlets.content.ContentPortletSettingsEditor

-

Content portlet settings editor, AJAX renderer

-
- -
-
-class pyams_portal.zmi.portlets.content.ContentPortletPreviewer(context, request, view, settings)
-

Bases: pyams_portal.portlet.PortletPreviewer

-

Content portlet previewer

-
- -
-
-class pyams_portal.zmi.portlets.content.ContentPortletSettingsEditor(context, request)
-

Bases: pyams_portal.zmi.portlet.PortletSettingsEditor

-

Content portlet settings editor

-
-
-settings = <InterfaceClass pyams_portal.portlets.content.interfaces.IContentPortletSettings>
-
- -
- -
-
-

pyams_portal.zmi.portlets.image module

-
-
-class pyams_portal.zmi.portlets.image.ImagePortletConfigurationAJAXEditor(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_portal.zmi.portlets.image.ImagePortletSettingsEditor

-

Image portlet settings editor, AJAX renderer

-
- -
-
-class pyams_portal.zmi.portlets.image.ImagePortletPreviewer(context, request, view, settings)
-

Bases: pyams_portal.portlet.PortletPreviewer

-

Image portlet previewer

-
- -
-
-class pyams_portal.zmi.portlets.image.ImagePortletSettingsEditor(context, request)
-

Bases: pyams_portal.zmi.portlet.PortletSettingsEditor

-

Image portlet settings editor

-
-
-settings = <InterfaceClass pyams_portal.portlets.image.interfaces.IImagePortletSettings>
-
- -
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_security.html --- a/src/build/html/pyams_security.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1084 +0,0 @@ - - - - - - - PyAMS security — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

PyAMS security

-
-

Module contents

-
-
-pyams_security.includeme(config)
-

Pyramid include

-

Split in another package to remove cyclic dependencies with TranslationStringFactory

-
- -
- -
-

Submodules

-
-

pyams_security.credential module

-
-
-class pyams_security.credential.Credentials(prefix, id, **attributes)
-

Bases: object

-

Credentials class

-
-
-attributes
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-id
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-prefix
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-

pyams_security.include module

-
-
-pyams_security.include.include_package(config)
-

Pyramid include

-
- -
-
-

pyams_security.index module

-
-
-class pyams_security.index.PrincipalsRoleIndex(role_id, family=None)
-

Bases: hypatia.keyword.KeywordIndex

-

Principals role index

-
-
-discriminate(obj, default)
-
- -
- -
-
-

pyams_security.notification module

-
-
-class pyams_security.notification.NotificationSettings
-

Bases: persistent.Persistent

-

Notification settings

-
-
-enable_notifications
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-mailer
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-sender_email
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-sender_name
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-service_name
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-service_owner
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-signature
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-subject_prefix
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_security.notification.SecurityNotificationSettingsFactory(context)
-

Security manager notifications factory adapter

-
- -
-
-

pyams_security.permission module

-
-
-class pyams_security.permission.Permission(values=None, **args)
-

Bases: object

-

Permission utility class

-
-
-description
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-id
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_security.permission.PermissionsVocabulary(*args, **kwargs)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

Permissions vocabulary

-
-
-interface = <InterfaceClass pyams_security.interfaces.IPermission>
-
- -
- -
-
-pyams_security.permission.register_permission(config, permission)
-

Register a new permission

-

Permissions registry is not required. -But only registered permissions can be applied via default -ZMI features

-
- -
-
-

pyams_security.principal module

-
-
-class pyams_security.principal.MissingPrincipal(**kwargs)
-

Bases: object

-

Missing principal info

-

This class can be used when a stored principal ID -references a principal which can’t be found anymore

-
-
-id
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-title
-
- -
- -
-
-class pyams_security.principal.PrincipalInfo(**kwargs)
-

Bases: object

-

Generic principal info

-
-
-attributes
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-id
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_security.principal.get_principal_annotations(principal)
-

Principal annotations adapter

-
- -
-
-

pyams_security.profile module

-
-
-pyams_security.profile.PrincipalPublicProfileFactory(principal)
-

Principal public profile factory adapter

-
- -
-
-class pyams_security.profile.ProfileTraverser(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

++profile++ namespace traverser

-
-
-traverse(name, furtherpath=None)
-
- -
- -
-
-class pyams_security.profile.PublicProfile
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Public profile persistent class

-
-
-avatar
-

Property class used to handle files

-
- -
- -
-
-class pyams_security.profile.PublicProfileExtension(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

public_profile TALES extension

-
-
-render(request=None)
-
- -
- -
-
-pyams_security.profile.PublicProfileFactory(context)
-
- -
-
-

pyams_security.property module

-
-
-class pyams_security.property.RolePrincipalsFieldProperty(field, role_id=None, name=None, **args)
-

Bases: object

-

Custom field property used to handle role principals

-
- -
-
-

pyams_security.role module

-
-
-class pyams_security.role.Role(values=None, **args)
-

Bases: object

-

Role utility class

-
-
-description
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-id
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-managers
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-permissions
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_security.role.RolesVocabulary(*args, **kwargs)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

Roles vocabulary

-
-
-interface = <InterfaceClass pyams_security.interfaces.IRole>
-
- -
- -
-
-pyams_security.role.register_role(config, role)
-

Register a new role

-

Roles registry is not required. -But only registered roles can be applied via default -ZMI features.

-

If a role is registered several times, previous registrations -will just be updated to add new permissions. -Title and description are not updated after first registration.

-
- -
-
-

pyams_security.schema module

-
-
-class pyams_security.schema.PermissionField(**kwargs)
-

Bases: zope.schema._field.Choice

-

Permission field

-
- -
-
-class pyams_security.schema.PermissionsSetField(**kwargs)
-

Bases: zope.schema._field.Set

-

Permissions set field

-
- -
-
-class pyams_security.schema.Principal(**kwargs)
-

Bases: zope.schema._bootstrapfields.TextLine

-

Principal field

-
-
-role_id = None
-
- -
- -
-
-class pyams_security.schema.PrincipalsSet(**kwargs)
-

Bases: zope.schema._field.Set

-

Principals set field

-
-
-role_id = None
-
- -
- -
-
-

pyams_security.security module

-
-
-class pyams_security.security.ProtectedObject
-

Bases: object

-

Base protected object class

-
- -
-
-pyams_security.security.ProtectedObjectFactory(context)
-

Default protected object factory

-
- -
-
-class pyams_security.security.RoleProtectedObject
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Base class for object protected by roles

-
-
-authenticated_denied
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-authenticated_granted
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-everyone_denied
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-everyone_granted
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-get_authenticated_denied()
-
- -
-
-get_authenticated_granted()
-
- -
-
-get_everyone_denied()
-
- -
-
-get_everyone_granted()
-
- -
-
-get_granted_roles()
-
- -
-
-get_permissions(principal_id)
-
- -
-
-get_principals(role_id)
-
- -
-
-get_roles(principal_id)
-
- -
-
-grant_role(role_id, principal_ids)
-
- -
-
-inherit_parent_roles
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-inherit_parent_security
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-revoke_role(role_id, principal_ids)
-
- -
- -
-
-

pyams_security.site module

-
-
-class pyams_security.site.SecurityGenerationsChecker
-

Bases: object

-

I18n generations checker

-
-
-evolve(site, current=None)
-

Check for required utilities

-
- -
-
-generation = 1
-
- -
- -
-
-pyams_security.site.get_admin_user()
-

Get system manager profile

-
- -
-
-pyams_security.site.get_service_user()
-

Get internal services profile

-
- -
-
-pyams_security.site.handle_new_local_site(event)
-

Create a new security manager when a site is created

-
- -
-
-pyams_security.site.handle_new_security_manager(event)
-

Automatically create a new administration login

-
- -
-
-

pyams_security.utility module

-
-
-class pyams_security.utility.PyAMSAuthenticationPolicy(secret, credentials=('http', ), cookie_name='auth_ticket', secure=False, include_ip=False, timeout=None, reissue_time=None, max_age=None, path='/', http_only=False, wild_domain=True, hashalg='sha256', parent_domain=False, domain=None)
-

Bases: object

-

PyAMS authentication policy

-

This authentication policy relies on a registered ISecurityManager utility. -Use same authentication ticket as AuthTktAuthenticationPolicy.

-

credentials is the list of credentials extraction utilities which can be -used to get credentials.

-

See pyramid.authentication.AuthTktAuthenticationPolicy to get description -of other constructor arguments.

-
-
-authenticated_userid(request)
-
- -
-
-credentials_plugins
-
- -
-
-effective_principals(x, *args, **kwargs)
-
- -
-
-forget(request)
-
- -
-
-remember(request, principal, **kw)
-
- -
-
-unauthenticated_userid(request)
-
- -
- -
-
-class pyams_security.utility.SecurityManager
-

Bases: zope.container.folder.Folder

-

Security manager utility

-
-
-authenticate(credentials, request)
-
- -
-
-authenticated_userid(request)
-
- -
-
-authentication_plugins_names
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-authomatic_secret
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-credentials_plugins_names
-
- -
-
-directory_plugins_names
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-effective_principals(principal_id, request=None, context=None)
-
- -
-
-enable_social_login
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-extract_credentials(request, **kwargs)
-
- -
-
-find_principals(query)
-
- -
-
-get_all_principals(principal_id)
-
- -
-
-get_authentication_plugins()
-
- -
-
-get_credentials_plugins(request=None)
-
- -
-
-get_directory_plugins()
-
- -
-
-get_groups_directory_plugins()
-
- -
-
-get_plugin(name)
-
- -
-
-get_principal
-
- -
-
-open_registration
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-social_login_use_popup
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-social_users_folder
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-users_folder
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_security.utility.get_principal(request, principal_id=None)
-

Get principal associated with given request

-
- -
-
-

pyams_security.vocabulary module

-
-
-class pyams_security.vocabulary.PasswordManagerVocabulary(context, **kw)
-

Bases: zope.componentvocabulary.vocabulary.UtilityVocabulary

-

Password managers vocabulary

-
-
-interface = <InterfaceClass zope.password.interfaces.IPasswordManager>
-
- -
-
-nameOnly = True
-
- -
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_security.tests.html --- a/src/build/html/pyams_security.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_security.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_security.tests package

-
-

Submodules

-
-
-

pyams_security.tests.test_utilsdocs module

-

Generic Test case for pyams_security doctest

-
-
-pyams_security.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_security.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_security.tests.test_utilsdocstrings module

-

Generic Test case for pyams_security doc strings

-
-
-pyams_security.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_security.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_security.widget.html --- a/src/build/html/pyams_security.widget.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,278 +0,0 @@ - - - - - - - pyams_security.widget package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_security.widget package

-
-

Submodules

-
-
-

pyams_security.widget.interfaces module

-
-
-

Module contents

-
-
-class pyams_security.widget.PermissionDataConverter(field, widget)
-

Bases: z3c.form.converter.BaseDataConverter

-

Permission data converter

-
-
-toFieldValue(value)
-
- -
-
-toWidgetValue(value)
-
- -
- -
-
-pyams_security.widget.PermissionFieldWidget(field, request)
-

Permission field widget factory

-
- -
-
-class pyams_security.widget.PermissionWidget(request)
-

Bases: z3c.form.browser.select.SelectWidget

-

Principal widget

-
-
-extract(default=<NO_VALUE>)
-
- -
-
-isSelected(term)
-
- -
-
-items()
-
- -
-
-value_map
-
- -
- -
-
-class pyams_security.widget.PermissionsSetDataConverter(field, widget)
-

Bases: z3c.form.converter.BaseDataConverter

-

Permissions set data converter

-
-
-toFieldValue(value)
-
- -
-
-toWidgetValue(value)
-
- -
- -
-
-pyams_security.widget.PermissionsSetFieldWidget(field, request)
-

Permissions set field widget factory

-
- -
-
-class pyams_security.widget.PermissionsSetWidget(request)
-

Bases: z3c.form.browser.widget.HTMLInputWidget, z3c.form.widget.Widget

-

Permissions set widget

-
-
-values_data
-
- -
-
-values_map
-
- -
-
-values_str
-
- -
- -
-
-class pyams_security.widget.PrincipalDataConverter(field, widget)
-

Bases: z3c.form.converter.BaseDataConverter

-

Principal data converter

-
-
-toFieldValue(value)
-
- -
-
-toWidgetValue(value)
-
- -
- -
-
-pyams_security.widget.PrincipalFieldWidget(field, request)
-

Principal field widget factory

-
- -
-
-class pyams_security.widget.PrincipalWidget(request)
-

Bases: z3c.form.browser.widget.HTMLInputWidget, z3c.form.widget.Widget

-

Principal widget

-
-
-value_map
-
- -
- -
-
-class pyams_security.widget.PrincipalsSetDataConverter(field, widget)
-

Bases: z3c.form.converter.BaseDataConverter

-

Principals set data converter

-
-
-toFieldValue(value)
-
- -
-
-toWidgetValue(value)
-
- -
- -
-
-pyams_security.widget.PrincipalsSetFieldWidget(field, request)
-

Principals set field widget factory

-
- -
-
-class pyams_security.widget.PrincipalsSetWidget(request)
-

Bases: z3c.form.browser.widget.HTMLInputWidget, z3c.form.widget.Widget

-

Principals set widget

-
-
-values_map
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_security.zmi.plugin.html --- a/src/build/html/pyams_security.zmi.plugin.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1873 +0,0 @@ - - - - - - - pyams_security.zmi.plugin package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_security.zmi.plugin package

-
-

Submodules

-
-
-

pyams_security.zmi.plugin.admin module

-
-
-class pyams_security.zmi.plugin.admin.AdminAuthenticationAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_security.zmi.plugin.admin.AdminAuthenticationAddForm

-

Admin authentication plug-in add form, AJAX handler

-
- -
-
-class pyams_security.zmi.plugin.admin.AdminAuthenticationAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_security.zmi.plugin.admin.AdminAuthenticationEditForm

-

Admin authentication plug-in edit form, AJAX handler

-
- -
-
-class pyams_security.zmi.plugin.admin.AdminAuthenticationAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Admin authentication plug-in add form

-
-
-add(plugin)
-
- -
-
-ajax_handler = 'add-admin-authentication.json'
-
- -
-
-autocomplete = 'off'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-support'
-
- -
-
-legend = 'Add administration authentication plug-in'
-
- -
-
-nextURL()
-
- -
-
-title = 'System security manager'
-
- -
- -
-
-class pyams_security.zmi.plugin.admin.AdminAuthenticationAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Admin authentication add menu

-
-
-label = 'Add admin authentication...'
-
- -
-
-label_css_class = 'fa fa-fw fa-support'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-admin-authentication.html'
-
- -
- -
-
-class pyams_security.zmi.plugin.admin.AdminAuthenticationEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Admin authentication plug-in edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-autocomplete = 'off'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-support'
-
- -
-
-legend = 'Edit administration authentication plug-in'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_security.zmi.plugin.admin.AdminAuthenticationHelpAdapter(context, request, view)
-

Bases: pyams_form.help.FormHelp

-

Admin authentication edit form help adapter

-
-
-header = 'WARNING'
-
- -
-
-message = 'Before disabling plug-in, please verify that you have other administration access!'
-
- -
-
-message_format = 'rest'
-
- -
-
-status = 'danger'
-
- -
- -
-
-pyams_security.zmi.plugin.admin.handle_new_admin_folder_data_extraction(event)
-

Handle new admin authentication plug-in form data extraction

-
- -
-
-

pyams_security.zmi.plugin.group module

-
-
-class pyams_security.zmi.plugin.group.DescriptionColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users registration date column

-
-
-attrName = 'description'
-
- -
-
-getValue(obj)
-
- -
-
-weight = 20
-
- -
- -
-
-class pyams_security.zmi.plugin.group.GroupsFolderAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_security.zmi.plugin.group.GroupsFolderAddForm

-

Groups folder plug-in add form, AJAX handler

-
- -
-
-class pyams_security.zmi.plugin.group.GroupsFolderAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_security.zmi.plugin.group.GroupsFolderEditForm

-

Groups folder plug-in edit form, AJAX handler

-
- -
-
-class pyams_security.zmi.plugin.group.GroupsFolderAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Groups folder plug-in add form

-
-
-add(plugin)
-
- -
-
-ajax_handler = 'add-groups-folder.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = None
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-users'
-
- -
-
-legend = 'Add local groups folder plug-in'
-
- -
-
-nextURL()
-
- -
-
-title = 'System security manager'
-
- -
- -
-
-class pyams_security.zmi.plugin.group.GroupsFolderAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Local groups folder add menu

-
-
-label = 'Add local groups folder...'
-
- -
-
-label_css_class = 'fa fa-fw fa-users'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-groups-folder.html'
-
- -
- -
-
-class pyams_security.zmi.plugin.group.GroupsFolderContentsTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Groups folder contents table

-
-
-cssClasses = {'table': 'table table-bordered table-striped table-hover table-tight datatable'}
-
- -
-
-id = 'groups_folder_table'
-
- -
-
-title = 'Local groups list'
-
- -
- -
-
-class pyams_security.zmi.plugin.group.GroupsFolderContentsValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Groups folder table values adapter

-
-
-values
-
- -
- -
-
-class pyams_security.zmi.plugin.group.GroupsFolderEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Groups folder plug-in edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-users'
-
- -
-
-legend = 'Edit local groups folder plug-in properties'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_security.zmi.plugin.group.GroupsFolderSearchView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

-

Groups folder search view

-
-
-table_class
-

alias of GroupsFolderContentsTable

-
- -
- -
-
-class pyams_security.zmi.plugin.group.GroupsFolderSearchViewHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Groups folder search view header adapter

-
-
-back_target = '#content'
-
- -
-
-back_url = '#security-manager.html'
-
- -
-
-icon_class = 'fa fa-fw fa-users'
-
- -
-
-subtitle
-
- -
-
-title = 'Security manager'
-
- -
- -
-
-class pyams_security.zmi.plugin.group.LocalGroupAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_security.zmi.plugin.group.LocalGroupAddForm

-

Local group add form, AJAX view

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_security.zmi.plugin.group.LocalGroupAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_security.zmi.plugin.group.LocalGroupEditForm

-

Local group edit form, AJAX view

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_security.zmi.plugin.group.LocalGroupAddAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Groups folder adding action

-
-
-label = 'Add group'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-group.html'
-
- -
- -
-
-class pyams_security.zmi.plugin.group.LocalGroupAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Local group add form

-
-
-add(group)
-
- -
-
-ajax_handler = 'add-group.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-users'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Add new local group'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
-
-update_content(group, data)
-
- -
- -
-
-class pyams_security.zmi.plugin.group.LocalGroupEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Local group edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-users'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Edit group properties'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_security.zmi.plugin.group.NameColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Group name column

-
-
-attrName = 'title'
-
- -
-
-weight = 10
-
- -
- -
-
-pyams_security.zmi.plugin.group.handle_new_user_data_extraction(event)
-

Handle new group form data extraction

-
- -
-
-pyams_security.zmi.plugin.group.handle_new_user_folder_data_extraction(event)
-

Handle new groups folder plug-in form data extraction

-
- -
-
-

pyams_security.zmi.plugin.social module

-
-
-class pyams_security.zmi.plugin.social.EmailColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users email column

-
-
-attrName = 'email'
-
- -
-
-weight = 20
-
- -
- -
-
-class pyams_security.zmi.plugin.social.IDColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users ID column

-
-
-attrName = 'user_id'
-
- -
-
-weight = 5
-
- -
- -
-
-class pyams_security.zmi.plugin.social.NameColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users name column

-
-
-attrName = 'title'
-
- -
-
-weight = 10
-
- -
- -
-
-class pyams_security.zmi.plugin.social.ProviderNameColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users provider name column

-
-
-attrName = 'provider_name'
-
- -
-
-weight = 30
-
- -
- -
-
-class pyams_security.zmi.plugin.social.RegistrationDateColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users registration date column

-
-
-getValue(obj)
-
- -
-
-weight = 40
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SecurityManagerSocialMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Security manager social menu

-
-
-label = 'Social networks login'
-
- -
-
-url = '#social-providers.html'
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SecurityManagerSocialProvidersHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Security manager social providers header adapter

-
-
-back_url = '#security-manager.html'
-
- -
-
-icon_class = 'fa fa-fw fa-share-alt'
-
- -
-
-subtitle = 'Social networks login providers'
-
- -
-
-title = 'Security manager'
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SecurityManagerSocialProvidersIconColumn(context, request, table)
-

Bases: pyams_skin.table.ActionColumn

-

Security manager plugins icon column

-
-
-renderCell(item)
-
- -
-
-weight = 1
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SecurityManagerSocialProvidersIdColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Security manager plugins name column

-
-
-attrName = 'provider_id'
-
- -
-
-cssClasses = {'th': 'action'}
-
- -
-
-weight = 5
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SecurityManagerSocialProvidersNameColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Security manager plugins name column

-
-
-attrName = 'provider_name'
-
- -
-
-weight = 10
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SecurityManagerSocialProvidersTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Security manager social providers table

-
-
-cssClasses = {'table': 'table table-bordered table-striped table-hover table-tight datatable'}
-
- -
-
-data_attributes
-
- -
-
-id = 'social_providers_table'
-
- -
-
-title = 'Configured social networks login providers'
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SecurityManagerSocialProvidersTrashColumn(context, request, table)
-

Bases: pyams_skin.table.TrashColumn

-

Security manager plugins trash column

-
-
-icon_hint = 'Delete provider'
-
- -
-
-permission = 'pyams.ManageSystem'
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SecurityManagerSocialProvidersValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Security manager social providers values adapter

-
-
-values
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SecurityManagerSocialProvidersView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

-

Security manager social providers view

-
-
-table_class
-

alias of SecurityManagerSocialProvidersTable

-
- -
- -
-
-class pyams_security.zmi.plugin.social.SocialProviderAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_security.zmi.plugin.social.SocialProviderAddForm

-

Social provider add form, AJAX view

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SocialProviderAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_security.zmi.plugin.social.SocialProviderEditForm

-

Social provider edit form, AJAX view

-
- -
-
-class pyams_security.zmi.plugin.social.SocialProviderAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Social provider add form

-
-
-add(object)
-
- -
-
-ajax_handler = 'add-social-provider.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-share-alt'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Add new social login provider'
-
- -
-
-title = 'Security manager'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SocialProviderEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Social provider edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-share-alt'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Edit social login provider properties'
-
- -
-
-title = 'Security manager'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SocialToolbarAddingsAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Security manager social toolbar adding action

-
-
-label = 'Add provider'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-social-provider.html'
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SocialUserAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_security.zmi.plugin.social.SocialUserEditForm

-

Social user edit form, AJAX view

-
- -
-
-class pyams_security.zmi.plugin.social.SocialUserEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Social user edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-share-alt'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Edit user properties'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SocialUsersFolderAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_security.zmi.plugin.social.SocialUsersFolderAddForm

-

Social users folder plug-in add form, AJAX handler

-
- -
-
-class pyams_security.zmi.plugin.social.SocialUsersFolderAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_security.zmi.plugin.social.SocialUsersFolderEditForm

-

Social users folder plug-in edit form, AJAX handler

-
- -
-
-class pyams_security.zmi.plugin.social.SocialUsersFolderAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Social users folder plug-in add form

-
-
-add(plugin)
-
- -
-
-ajax_handler = 'add-social-users-folder.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-share-alt'
-
- -
-
-legend = 'Add social users folder plug-in'
-
- -
-
-nextURL()
-
- -
-
-title = 'System security manager'
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SocialUsersFolderAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Social users folder add menu

-
-
-label = 'Add social users folder...'
-
- -
-
-label_css_class = 'fa fa-fw fa-share-alt'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-social-users-folder.html'
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SocialUsersFolderEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Social users folder plug-in edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-share-alt'
-
- -
-
-legend = 'Edit social users folder plug-in properties'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SocialUsersFolderSearchResultsView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_form.search.SearchResultsView

-

Social users folder search results view table

-
-
-cssClasses = {'table': 'table table-bordered table-striped table-hover table-tight datatable'}
-
- -
-
-id = 'social_users_folder_search_table'
-
- -
-
-title = 'Search results'
-
- -
- -
-
-class pyams_security.zmi.plugin.social.SocialUsersFolderSearchView(context, request)
-

Bases: pyams_form.search.SearchView

-

Social users folder search view

-
- -
-
-class pyams_security.zmi.plugin.social.SocialUsersFolderSearchViewHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Social users folder search view header adapter

-
-
-back_target = '#content'
-
- -
-
-back_url = '#security-manager.html'
-
- -
-
-icon_class = 'fa fa-fw fa-share-alt'
-
- -
-
-subtitle
-
- -
-
-title = 'Security manager'
-
- -
- -
-
-pyams_security.zmi.plugin.social.delete_social_provider(request)
-

Delete social provider from security manager

-
- -
-
-pyams_security.zmi.plugin.social.handle_new_social_provider_data_extraction(event)
-

Handle new social provider data extraction

-
- -
-
-pyams_security.zmi.plugin.social.handle_new_user_folder_data_extraction(event)
-

Handle new social users folder form data extraction

-
- -
-
-

pyams_security.zmi.plugin.userfolder module

-
-
-class pyams_security.zmi.plugin.userfolder.ConfirmationDateColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users activation date column

-
-
-getValue(obj)
-
- -
-
-weight = 40
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.EmailColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users email column

-
-
-attrName = 'email'
-
- -
-
-weight = 20
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.LocalUserAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_security.zmi.plugin.userfolder.LocalUserAddForm

-

Local user add form, AJAX view

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.LocalUserAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_security.zmi.plugin.userfolder.LocalUserEditForm

-

Local user edit form, AJAX view

-
- -
-
-class pyams_security.zmi.plugin.userfolder.LocalUserAddAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Users folder adding action

-
-
-label = 'Add user'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-user.html'
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.LocalUserAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Local user add form

-
-
-add(user)
-
- -
-
-ajax_handler = 'add-user.json'
-
- -
-
-autocomplete = 'off'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-user'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Add new local user'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
-
-update_content(user, data)
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.LocalUserEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Local user edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-user'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Edit user properties'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.LoginColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users login column

-
-
-attrName = 'login'
-
- -
-
-weight = 5
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.NameColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users name column

-
-
-attrName = 'title'
-
- -
-
-weight = 10
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.RegistrationDateColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Users registration date column

-
-
-getValue(obj)
-
- -
-
-weight = 30
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.UsersFolderAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_security.zmi.plugin.userfolder.UsersFolderAddForm

-

users folder plug-in add form, AJAX handler

-
- -
-
-class pyams_security.zmi.plugin.userfolder.UsersFolderAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_security.zmi.plugin.userfolder.UsersFolderEditForm

-

Users folder plug-in edit form, AJAX handler

-
- -
-
-class pyams_security.zmi.plugin.userfolder.UsersFolderAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Users folder plug-in add form

-
-
-add(plugin)
-
- -
-
-ajax_handler = 'add-users-folder.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-user'
-
- -
-
-legend = 'Add local users folder plug-in'
-
- -
-
-nextURL()
-
- -
-
-title = 'System security manager'
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.UsersFolderAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Local users folder add menu

-
-
-label = 'Add local users folder...'
-
- -
-
-label_css_class = 'fa fa-fw fa-user'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-users-folder.html'
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.UsersFolderEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Users folder plug-in edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-user'
-
- -
-
-legend = 'Edit local users folder plug-in properties'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.UsersFolderSearchResultsView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_form.search.SearchResultsView

-

Users folder search results view table

-
-
-cssClasses = {'table': 'table table-bordered table-striped table-hover table-tight datatable'}
-
- -
-
-id = 'users_folder_search_table'
-
- -
-
-title = 'Search results'
-
- -
- -
-
-class pyams_security.zmi.plugin.userfolder.UsersFolderSearchView(context, request)
-

Bases: pyams_form.search.SearchView

-

Users folder search view

-
- -
-
-class pyams_security.zmi.plugin.userfolder.UsersFolderSearchViewHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Users folder search view header adapter

-
-
-back_target = '#content'
-
- -
-
-back_url = '#security-manager.html'
-
- -
-
-icon_class = 'fa fa-fw fa-user'
-
- -
-
-subtitle
-
- -
-
-title = 'Security manager'
-
- -
- -
-
-pyams_security.zmi.plugin.userfolder.handle_new_user_data_extraction(event)
-

Handle new user form data extraction

-
- -
-
-pyams_security.zmi.plugin.userfolder.handle_new_user_folder_data_extraction(event)
-

Handle new user folder form data extraction

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_security.zmi.widget.html --- a/src/build/html/pyams_security.zmi.widget.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,144 +0,0 @@ - - - - - - - pyams_security.zmi.widget package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_security.zmi.widget package

-
-

Module contents

-
-
-class pyams_security.zmi.widget.OrderdedPluginsDataConverter(field, widget)
-

Bases: z3c.form.converter.BaseDataConverter

-

Ordered plugins data converter

-
-
-toFieldValue(value)
-
- -
-
-toWidgetValue(value)
-
- -
- -
-
-pyams_security.zmi.widget.OrderedPluginsFieldWidget(field, request)
-
- -
-
-class pyams_security.zmi.widget.OrderedPluginsWidget(request)
-

Bases: z3c.form.browser.widget.HTMLFormElement, z3c.form.widget.Widget

-

Ordered plug-ins list widget

-
-
-items()
-
- -
-
-str_value()
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_sequence.interfaces.html --- a/src/build/html/pyams_sequence.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_sequence.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_sequence.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_sequence.tests.html --- a/src/build/html/pyams_sequence.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_sequence.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_sequence.tests package

-
-

Submodules

-
-
-

pyams_sequence.tests.test_utilsdocs module

-

Generic Test case for pyams_sequence doctest

-
-
-pyams_sequence.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_sequence.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_sequence.tests.test_utilsdocstrings module

-

Generic Test case for pyams_sequence doc strings

-
-
-pyams_sequence.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_sequence.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_sequence.zmi.html --- a/src/build/html/pyams_sequence.zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,155 +0,0 @@ - - - - - - - pyams_sequence.zmi package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_sequence.zmi package

-
-

Module contents

-
-
-class pyams_sequence.zmi.SequentialIntIdsPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_sequence.zmi.SequentialIntIdsPropertiesEditForm

-

Sequential IDs properties edit form, JSON renderer

-
- -
-
-class pyams_sequence.zmi.SequentialIntIdsPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Sequential IDs properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-legend = 'Display sequence properties'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-pyams_sequence.zmi.handle_sequence_data_extraction(event)
-

Handle sequence properties data extraction

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_skin.interfaces.html --- a/src/build/html/pyams_skin.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,144 +0,0 @@ - - - - - - - pyams_skin.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_skin.interfaces package

-
-

Submodules

-
-
-

pyams_skin.interfaces.configuration module

-
-
-

pyams_skin.interfaces.container module

-
-
-

pyams_skin.interfaces.extension module

-
-
-

pyams_skin.interfaces.metas module

-
-
-

pyams_skin.interfaces.resources module

-
-
-

pyams_skin.interfaces.tinymce module

-
-
-

pyams_skin.interfaces.viewlet module

-
-
-

Module contents

-
-
-class pyams_skin.interfaces.SkinChangedEvent(object)
-

Bases: zope.interface.interfaces.ObjectEvent

-

Request skin changed event

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_skin.tests.html --- a/src/build/html/pyams_skin.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_skin.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_skin.tests package

-
-

Submodules

-
-
-

pyams_skin.tests.test_utilsdocs module

-

Generic Test case for pyams_skin doctest

-
-
-pyams_skin.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_skin.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_skin.tests.test_utilsdocstrings module

-

Generic Test case for pyams_skin doc strings

-
-
-pyams_skin.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_skin.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_skin.viewlet.breadcrumb.html --- a/src/build/html/pyams_skin.viewlet.breadcrumb.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,159 +0,0 @@ - - - - - - - pyams_skin.viewlet.breadcrumb package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_skin.viewlet.breadcrumb package

-
-

Module contents

-
-
-class pyams_skin.viewlet.breadcrumb.BreadcrumbItem(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

Breadcrumb item

-
-
-css_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-label
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-url
-
- -
-
-view_name
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_skin.viewlet.breadcrumb.BreadcrumbsContentProvider(context, request, view)
-

Bases: pyams_viewlet.viewlet.ViewContentProvider

-

Breadcrumbs content provider

-
-
-items
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_skin.viewlet.flags.html --- a/src/build/html/pyams_skin.viewlet.flags.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,127 +0,0 @@ - - - - - - - pyams_skin.viewlet.flags package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_skin.viewlet.flags package

-
-

Module contents

-
-
-class pyams_skin.viewlet.flags.FlagsContentProvider
-

Bases: object

-

Flags content provider

-
-
-current
-
- -
-
-get_label(lang)
-
- -
-
-langs
-
- -
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_skin.viewlet.html --- a/src/build/html/pyams_skin.viewlet.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,153 +0,0 @@ - - - - - - - pyams_skin.viewlet package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- - - - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_skin.viewlet.search.html --- a/src/build/html/pyams_skin.viewlet.search.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,119 +0,0 @@ - - - - - - - pyams_skin.viewlet.search package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_skin.viewlet.search package

-
-

Module contents

-
-
-class pyams_skin.viewlet.search.MobileSearchViewlet
-

Bases: object

-

Mobile search content provider

-
- -
-
-class pyams_skin.viewlet.search.SiteSearchViewlet
-

Bases: object

-

Site search content provider

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_skin.viewlet.shortcuts.html --- a/src/build/html/pyams_skin.viewlet.shortcuts.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,194 +0,0 @@ - - - - - - - pyams_skin.viewlet.shortcuts package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_skin.viewlet.shortcuts package

-
-

Module contents

-
-
-class pyams_skin.viewlet.shortcuts.Shortcut(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Shortcut viewlet

-
-
-bg_color_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-checked
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-get_url()
-
- -
-
-icon_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-label
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-modal_target
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-target
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-url
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_skin.viewlet.shortcuts.ShortcutsViewletManager(context, request, view)
-

Bases: pyams_viewlet.manager.TemplateBasedViewletManager, pyams_viewlet.manager.WeightOrderedViewletManager

-

Shortcuts viewlet manager

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_skin.viewlet.toolbar.html --- a/src/build/html/pyams_skin.viewlet.toolbar.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,518 +0,0 @@ - - - - - - - pyams_skin.viewlet.toolbar package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_skin.viewlet.toolbar package

-
-

Module contents

-
-
-class pyams_skin.viewlet.toolbar.ContextActionsExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:context_actions(context) TALES extension

-
-
-render(context=None)
-
- -
- -
-
-class pyams_skin.viewlet.toolbar.ContextActionsViewletManager(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenu

-

Context actions viewlet manager

-
-
-css_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-label = 'Other actions...'
-
- -
-
-label_css_class = ''
-
- -
- -
-
-class pyams_skin.viewlet.toolbar.JsToolbarAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Javascript toolbar action

-
-
-get_url()
-
- -
- -
-
-class pyams_skin.viewlet.toolbar.JsToolbarActionItem(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarActionItem

-

Javascript call toolbar action item

-
-
-get_url()
-
- -
- -
-
-class pyams_skin.viewlet.toolbar.JsToolbarMenuItem(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Javascript call toolbar menu item

-
-
-get_url()
-
- -
- -
-
-class pyams_skin.viewlet.toolbar.TableItemColumnActionsMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenu

-

Table item actions menu

-
-
-css_class = 'btn btn-xs btn-info dropdown-toggle'
-
- -
-
-label = 'Actions...'
-
- -
-
-label_css_class = ''
-
- -
- -
-
-class pyams_skin.viewlet.toolbar.TableToolbarViewletManager(context, request, view)
-

Bases: pyams_viewlet.manager.TemplateBasedViewletManager, pyams_viewlet.manager.WeightOrderedViewletManager

-

Table toolbar viewlet manager

-
- -
-
-class pyams_skin.viewlet.toolbar.ToolbarAction(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Base toolbar action class

-
-
-click_handler
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-css_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-get_url()
-
- -
-
-label
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-label_css_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-modal_target
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-url
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_skin.viewlet.toolbar.ToolbarActionItem(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Toolbar action item class

-
-
-click_handler
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-css_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-get_url()
-
- -
-
-hint_gravity
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-label
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-label_css_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-modal_target
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-stop_propagation
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-url
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_skin.viewlet.toolbar.ToolbarAddingMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenu

-

Toolbar adding menu

-
-
-css_class = 'btn btn-xs btn-success dropdown-toggle'
-
- -
-
-label = 'Add...'
-
- -
-
-menu_css_class = 'dropdown-menu'
-
- -
- -
-
-class pyams_skin.viewlet.toolbar.ToolbarMenu(context, request, view, manager=None)
-

Bases: pyams_viewlet.manager.TemplateBasedViewletManager, pyams_viewlet.manager.WeightOrderedViewletManager, pyams_viewlet.viewlet.Viewlet

-

Base toolbar menu class

-
-
-click_handler
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-css_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-get_url()
-
- -
-
-label
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-label_css_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-menu_css_class
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-modal_target
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-render()
-
- -
-
-update()
-
- -
-
-url
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_skin.viewlet.toolbar.ToolbarMenuDivider(context, request, view, manager)
-

Bases: pyams_viewlet.viewlet.Viewlet

-

Toolbar menu divider

-
-
-css_class = 'divider'
-
- -
-
-lebel = None
-
- -
- -
-
-class pyams_skin.viewlet.toolbar.ToolbarMenuItem(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarActionItem

-

Toolbar menu item class

-
- -
-
-class pyams_skin.viewlet.toolbar.WidgetTitleViewletManager(context, request, view)
-

Bases: pyams_viewlet.manager.WeightOrderedViewletManager

-

Widget title extensions viewlet manager

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_thesaurus.interfaces.html --- a/src/build/html/pyams_thesaurus.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,155 +0,0 @@ - - - - - - - pyams_thesaurus.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_thesaurus.interfaces package

-
-

Module contents

-
-
-pyams_thesaurus.interfaces.ADMIN_THESAURUS_PERMISSION = 'pyams.AdminThesaurus'
-

Permission to administer all thesaurus properties

-
- -
-
-pyams_thesaurus.interfaces.CREATE_THESAURUS_PERMISSION = 'pyams.CreateThesaurus'
-

Permission to create thesaurus

-
- -
-
-pyams_thesaurus.interfaces.MANAGE_THESAURUS_CONTENT_PERMISSION = 'pyams.ManageThesaurusContent'
-

Permission to manage thesaurus contents

-
- -
-
-pyams_thesaurus.interfaces.MANAGE_THESAURUS_EXTRACT_PERMISSION = 'pyams.ManageThesaurusExtract'
-

Permission to manage thesaurus extract contents

-
- -
-
-

Submodules

-
-

pyams_thesaurus.interfaces.extension module

-
-
-

pyams_thesaurus.interfaces.index module

-
-
-

pyams_thesaurus.interfaces.loader module

-
-
-

pyams_thesaurus.interfaces.term module

-
-
-

pyams_thesaurus.interfaces.thesaurus module

-
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_thesaurus.rpc.html --- a/src/build/html/pyams_thesaurus.rpc.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,117 +0,0 @@ - - - - - - - pyams_thesaurus.rpc package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_thesaurus.rpc package

-
-

Module contents

-
- -
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_thesaurus.tests.html --- a/src/build/html/pyams_thesaurus.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,145 +0,0 @@ - - - - - - - pyams_thesaurus.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_thesaurus.tests package

-
-

Module contents

-
-
-

Submodules

-
-

pyams_thesaurus.tests.test_utilsdocs module

-

Generic Test case for pyams_thesaurus doctest

-
-
-pyams_thesaurus.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_thesaurus.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_thesaurus.tests.test_utilsdocstrings module

-

Generic Test case for pyams_thesaurus doc strings

-
-
-pyams_thesaurus.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_thesaurus.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_thesaurus.widget.html --- a/src/build/html/pyams_thesaurus.widget.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,248 +0,0 @@ - - - - - - - pyams_thesaurus.widget package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_thesaurus.widget package

-
-

Module contents

-
-
-class pyams_thesaurus.widget.ThesaurusTermDataConverter(field, widget)
-

Bases: z3c.form.converter.BaseDataConverter

-

Thesaurus term data converter

-
-
-toFieldValue(value)
-
- -
-
-toWidgetValue(value)
-
- -
- -
-
-pyams_thesaurus.widget.ThesaurusTermFieldWidget(field, request)
-

Thesaurus term field widget factory

-
- -
-
-class pyams_thesaurus.widget.ThesaurusTermWidget(request)
-

Bases: z3c.form.browser.widget.HTMLInputWidget, z3c.form.widget.Widget

-

Thesaurus term widget

-
-
-extract_name
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-query_params
-
- -
-
-thesaurus_name
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-values_map
-
- -
- -
-
-class pyams_thesaurus.widget.ThesaurusTermsListDataConverter(field, widget)
-

Bases: z3c.form.converter.BaseDataConverter

-

Thesaurus terms list data converter

-
-
-toFieldValue(value)
-
- -
-
-toWidgetValue(value)
-
- -
- -
-
-pyams_thesaurus.widget.ThesaurusTermsListFieldWidget(field, request)
-

Thesaurus terms list field widget factory

-
- -
-
-pyams_thesaurus.widget.ThesaurusTermsListSelectorFieldWidget(field, request)
-

Thesaurus terms list field widget with selector factory

-
- -
-
-class pyams_thesaurus.widget.ThesaurusTermsListSelectorWidget(request)
-

Bases: pyams_thesaurus.widget.ThesaurusTermsListWidget

-

Thesaurus terms list widget with selector

-
- -
-
-class pyams_thesaurus.widget.ThesaurusTermsListWidget(request)
-

Bases: z3c.form.browser.widget.HTMLInputWidget, z3c.form.widget.Widget

-

Thesaurus terms list widget

-
-
-extract_name
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-query_params
-
- -
-
-thesaurus_name
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-values_map
-
- -
- -
-
-

Submodules

-
-

pyams_thesaurus.widget.interfaces module

-
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_utils.html --- a/src/build/html/pyams_utils.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,2524 +0,0 @@ - - - - - - - PyAMS utilities — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

PyAMS utilities

- -
-

Module contents

-
-
-pyams_utils.includeme(config)
-

pyams_utils features include

-
- -
-
-

Submodules

-
-

pyams_utils.adapter module

-

Adapters management package

-

This package provides a small set of standard base adapters for context, context and request, and -context and request and view.

-

See Managing ZCA with PyAMS to see how PyAMS can help components management.

-
-
-class pyams_utils.adapter.ContextAdapter(context)
-

Bases: object

-

Context adapter

-
- -
-
-class pyams_utils.adapter.ContextRequestAdapter(context, request)
-

Bases: object

-

Context + request multi-adapter

-
- -
-
-class pyams_utils.adapter.ContextRequestViewAdapter(context, request, view)
-

Bases: object

-

Context + request + view multi-adapter

-
- -
-
-class pyams_utils.adapter.NullAdapter
-

Bases: object

-

An adapter which always return None!

-

Can be useful to override a default adapter…

-
- -
-
-class pyams_utils.adapter.adapter_config(**settings)
-

Bases: object

-

Function or class decorator to declare an adapter

-

Annotation parameters can be:

- --- - - - -
Parameters:
    -
  • name (str) – (default=’‘), name of the adapter
    • -
  • context ([Interface...]) – an interface, or a tuple of interfaces, that the component adapts
    • -
  • provides (Interface) – the interface that the adapter provides
    • -
-
-
-
-venusian = <module 'venusian' from '/var/local/env/pyams/eggs/venusian-1.1.0-py3.5.egg/venusian/__init__.py'>
-
- -
- -
-
-

pyams_utils.attr module

-
-
-class pyams_utils.attr.AttributeTraverser(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

++attr++ namespace traverser

-

This custom traversing adapter can be used to access an object attribute directly from -an URL by using a path like this:

-
/path/to/object/++attr++name
-
-
-

Whare name is the name of the requested attribute

-
-
-traverse(name, furtherpath=None)
-
- -
- -
-
-

pyams_utils.container module

-
-
-class pyams_utils.container.BTreeOrderedContainer
-

Bases: zope.container.ordered.OrderedContainer

-

BTree based ordered container

-

This container maintain a manual order of it’s contents

-
- -
-
-class pyams_utils.container.ContainerSublocationsAdapter(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Contained object sub-locations adapter

-

This adapter checks for custom ISublocations interface adapters which can -be defined by any component to get access to inner locations, defined for -example via annotations.

-
-
-sublocations()
-

See zope.location.interfaces.ISublocations interface

-
- -
- -
-
-pyams_utils.container.find_objects_matching(root, condition, ignore_root=False)
-

Find all objects in root that match the condition

-

The condition is a Python callable object that takes an object as -argument and must return a boolean result.

-

All sub-objects of the root will also be searched recursively.

- --- - - - - - -
Parameters:
    -
  • root (object) – the parent object from which search is started
    • -
  • condition (callable) – a callable object which may return true for a given -object to be selected
    • -
  • ignore_root (boolean) – if True, the root object will not be returned, even if it matches -the given condition
    • -
-
Returns:

an iterator for all root’s sub-objects matching condition

-
-
- -
-
-pyams_utils.container.find_objects_providing(root, interface)
-

Find all objects in root that provide the specified interface

-

All sub-objects of the root will also be searched recursively.

- --- - - - - - -
Parameters:
    -
  • root (object) – object; the parent object from which search is started
    • -
  • interface (Interface) – interface; an interface that sub-objects should provide
    • -
-
Returns:

an iterator for all root’s sub-objects that provide the given interface

-
-
- -
-
-

pyams_utils.context module

-
-
-class pyams_utils.context.ContextSelector(ifaces, config)
-

Bases: object

-

Interface based context selector

-

This selector can be used as a subscriber predicate to define -an interface that the context must support for the event to be applied:

-
.. code-block:: python
-
-
-
-

from pyams_utils.interfaces.site import ISiteRoot

-

@subscriber(IObjectModifiedEvent, context_selector=ISiteRoot) -def siteroot_modified_event_handler(event):

-
-
‘’‘This is an event handler for an ISiteRoot object modification event’‘’
-
-
-
-phash()
-
- -
-
-text()
-
- -
- -
-
-

pyams_utils.data module

-

Object data API module

-

The IObjectData interface is a generic interface which can be used to assign custom data to nay object. -This object data may be any object which can be serialized to JSON, and assigned to any HTML data attribute. -It can typically be used to set a data-ams-data attribute to objects, which is afterwards converted to -classic data- attributes by MyAMS.js framework.

-

For example, for a custom widget in a form:

-
def updateWidgets(self):
-    super(MyForm, self).updateWidgets()
-    widget = self.widgets['mywidget']
-    alsoProvides(widget, IObjectData)
-    widget.object_data = {'ams-colorpicker-position': 'top left'}
-
-
-

You can then set an attribute in a TAL template like this:

-
<div tal:attributes="data-ams-data extension:object_data(widget)">...</div>
-
-
-

After data initialization by MyAMS.js, the following code will be converted to:

-
<div data-ams-colorpicker-position="top left">...</div>
-
-
-
-
-class pyams_utils.data.BrowserRequestDataExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:request_data TALES extension for Zope browser request

-

This TALES extension can be used to get a request data, previously stored in the request via an annotation. -For example:

-
.. code-block:: html
-
-
-
-
<div tal:content=”extension:request_data(‘my.annotation.key’)”>…</div>
-
-
-render(params=None)
-

See pyams_utils.interfaces.tales.ITALESExtension interface

-
- -
- -
-
-class pyams_utils.data.ObjectDataExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:object_data TALES extension

-

This TALES extension is to be used in Chameleon templates to define a custom data attribute -which stores all object data (see pyams_utils.interfaces.data.IObjectData interface), like this:

-
.. code-block:: html
-
-
-
-
<div tal:attributes=”data-ams-data extension:object_data(context)”>…</div>
-
-
-render(context=None)
-

See pyams_utils.interfaces.tales.ITALESExtension interface

-
- -
- -
-
-class pyams_utils.data.ObjectDataRenderer(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Object data JSON renderer

-
-
-get_object_data()
-

See pyams_utils.interfaces.data.IObjectDataRenderer interface

-
- -
- -
-
-class pyams_utils.data.PyramidRequestDataExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:request_data TALES extension for Pyramid request

-

This TALES extension can be used to get a request data, previously stored in the request via an annotation. -For example:

-
.. code-block:: html
-
-
-
-
<div tal:content=”extension:request_data(‘my.annotation.key’)”>…</div>
-
-
-render(params=None)
-

See pyams_utils.interfaces.tales.ITALESExtension interface

-
- -
- -
-
-

pyams_utils.date module

-
-
-pyams_utils.date.date_to_datetime(value)
-

Get datetime value converted from a date or datetime object

- --- - - - - - -
Parameters:value (date/datetime) – a date or datetime value to convert
Returns:datetime; input value converted to datetime
-
>>> from datetime import date, datetime
->>> from pyams_utils.date import date_to_datetime
->>> value = date(2016, 11, 15)
->>> date_to_datetime(value)
-datetime.datetime(2016, 11, 15, 0, 0)
->>> value = datetime(2016, 11, 15, 10, 13, 12)
->>> value
-datetime.datetime(2016, 11, 15, 10, 13, 12)
->>> date_to_datetime(value) is value
-True
-
-
-
- -
-
-pyams_utils.date.format_date(value, format='on %d/%m/%Y', request=None)
-

Format given date with the given format

- --- - - - - - -
Parameters:
    -
  • value (datetime) – the value to format
    • -
  • format (str) – a format string to use by strftime function
    • -
  • request – the request from which to extract localization info for translation
    • -
-
Returns:

str; input datetime converted to given format

-
-
>>> from datetime import datetime
->>> from pyams_utils.date import format_date, SH_DATE_FORMAT
->>> value = datetime(2016, 11, 15, 10, 13, 12)
->>> format_date(value)
-'on 15/11/2016'
->>> format_date(value, SH_DATE_FORMAT)
-'15/11/2016'
-
-
-
- -
-
-pyams_utils.date.format_datetime(value, format='on %d/%m/%Y at %H:%M', request=None)
-

Format given datetime with the given format including time

- --- - - - - - -
Parameters:
    -
  • value (datetime) – the value to format
    • -
  • format (str) – a format string to use by strftime function
    • -
  • request – request; the request from which to extract localization info for translation
    • -
-
Returns:

str; input datetime converted to given format

-
-
>>> from datetime import datetime
->>> from pyams_utils.date import format_datetime, SH_DATETIME_FORMAT
->>> value = datetime(2016, 11, 15, 10, 13, 12)
->>> format_datetime(value)
-'on 15/11/2016 at 10:13'
->>> format_datetime(value, SH_DATETIME_FORMAT)
-'15/11/2016 - 10:13'
-
-
-
- -
-
-pyams_utils.date.get_age(value, request=None)
-

Get ‘human’ age of a given datetime (including timezone) compared to current datetime (in UTC)

- --- - - - - - -
Parameters:value (datetime) – input datetime to be compared with current datetime
Returns:str; the delta value, converted to months, weeks, days, hours or minutes
-
- -
-
-pyams_utils.date.get_duration(v1, v2=None, request=None)
-

Get ‘human’ delta as string between two dates

- --- - - - - - -
Parameters:
    -
  • v1 (datetime) – start date
    • -
  • v2 (datetime) – end date, or current date (in UTC) if None
    • -
  • request – the request from which to extract localization infos
    • -
-
Returns:

str; approximate delta between the two input dates

-
-
>>> from datetime import datetime
->>> from pyams_utils.date import get_duration
->>> from pyramid.testing import DummyRequest
->>> request = DummyRequest()
->>> date1 = datetime(2015, 1, 1)
->>> date2 = datetime(2014, 3, 1)
->>> get_duration(date1, date2, request)
-'10 months'
-
-
-

Dates order is not important:

-
>>> get_duration(date2, date1, request)
-'10 months'
->>> date2 = datetime(2014, 11, 10)
->>> get_duration(date1, date2, request)
-'7 weeks'
->>> date2 = datetime(2014, 12, 26)
->>> get_duration(date1, date2, request)
-'6 days'
-
-
-

For durations lower than 2 days, duration also display hours:

-
>>> date1 = datetime(2015, 1, 1)
->>> date2 = datetime(2015, 1, 2, 15, 10, 0)
->>> get_duration(date1, date2, request)
-'1 day and 15 hours'
->>> date2 = datetime(2015, 1, 2)
->>> get_duration(date1, date2, request)
-'24 hours'
->>> date2 = datetime(2015, 1, 1, 13, 12)
->>> get_duration(date1, date2, request)
-'13 hours'
->>> date2 = datetime(2015, 1, 1, 1, 15)
->>> get_duration(date1, date2, request)
-'75 minutes'
->>> date2 = datetime(2015, 1, 1, 0, 0, 15)
->>> get_duration(date1, date2, request)
-'15 seconds'
-
-
-
- -
-
-pyams_utils.date.parse_date(value)
-

Get date specified in unicode ISO format to Python datetime object

-

Dates are always assumed to be stored in GMT timezone

- --- - - - - - -
Parameters:value (str) – unicode date to be parsed
Returns:datetime; the specified value, converted to datetime
-
>>> from pyams_utils.date import parse_date
->>> parse_date('2016-11-15T10:13:12+00:00')
-datetime.datetime(2016, 11, 15, 10, 13, 12, tzinfo=<StaticTzInfo 'GMT'>)
-
-
-
- -
-
-pyams_utils.date.unidate(value)
-

Get specified date converted to unicode ISO format

-

Dates are always assumed to be stored in GMT timezone

- --- - - - - - -
Parameters:value (date) – input date to convert to unicode
Returns:unicode; input date converted to unicode
-
>>> from datetime import datetime
->>> from pyams_utils.date import unidate
->>> value = datetime(2016, 11, 15, 10, 13, 12)
->>> unidate(value)
-'2016-11-15T10:13:12+00:00'
-
-
-
- -
-
-

pyams_utils.decorator module

-
-
-pyams_utils.decorator.deprecated(*msg)
-

This is a decorator which can be used to mark functions as deprecated.

-

It will result in a warning being emitted when the function is used.

-
- -
-
-

pyams_utils.dict module

-
-
-pyams_utils.dict.update_dict(input, key, value)
-

Update given mapping if input value is a boolean ‘true’ value

- --- - - - -
Parameters:
    -
  • input (dict) – input dictionary
    • -
  • key – mapping key
    • -
  • value – new value
    • -
-
-

‘False’ values leave mapping unchanged:

-
>>> from pyams_utils.dict import update_dict
->>> mydict = {}
->>> update_dict(mydict, 'key1', None)
->>> mydict
-
-
-

{} ->>> update_dict(mydict, ‘key1’, ‘’) ->>> mydict -{} ->>> update_dict(mydict, ‘key1’, 0) ->>> mydict -{}

-

‘True’ values modify the mapping:

-
>>> update_dict(mydict, 'key1', 'value')
->>> mydict
-
-
-

{‘key1’: ‘value’} ->>> update_dict(mydict, ‘key1’, ‘value2’) ->>> mydict -{‘key1’: ‘value2’}

-
- -
-
-

pyams_utils.encoding module

-
-
-class pyams_utils.encoding.EncodingField(vocabulary='PyAMS encodings', **kw)
-

Bases: zope.schema._field.Choice

-

Encoding schema field

-
- -
-
-class pyams_utils.encoding.EncodingsVocabulary(terms, *interfaces)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

A vocabulary containing a set of registered encodings

-
- -
-
-

pyams_utils.fanstatic module

-
-
-class pyams_utils.fanstatic.ExternalResource(library, path, defer=False, **kwargs)
-

Bases: fanstatic.core.Resource

-

Fanstatic external resource

-
-
-render(library_url)
-
- -
- -
-
-class pyams_utils.fanstatic.FanstaticTalesExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:resource_path() TALES extension

-

This TALES extension generates an URL matching a given Fanstatic resource. -Resource is given as a string made of package name (in dotted form) followed by a colon and by the resource name.

-

For example:

-
.. code-block:: html
-
-
-
-
<div tal:attributes=”data-ams-plugin-pyams_content-src extension:resource_path(‘pyams_content.skin:pyams_content’)” />
-
-
-render(resource)
-
- -
- -
-
-pyams_utils.fanstatic.get_resource_path(resource, signature='--static--', versioning=True)
-

Get path for given resource

-
- -
-
-pyams_utils.fanstatic.render_js(url, defer=False)
-
- -
-
-

pyams_utils.html module

-
-
-class pyams_utils.html.MyHTMLParser(*, convert_charrefs=True)
-

Bases: html.parser.HTMLParser

-

HTML parser

-
-
-charrefs = {34: '"', 38: '&', 39: "'", 60: '<', 62: '>', 192: 'À', 193: 'A', 194: 'Â', 195: 'A', 196: 'Ä', 197: 'A', 198: 'AE', 199: 'Ç', 200: 'È', 201: 'É', 202: 'Ê', 203: 'Ë', 204: 'I', 205: 'I', 206: 'Î', 207: 'Ï', 208: 'D', 209: 'N', 210: 'O', 211: 'O', 212: 'Ô', 213: 'O', 214: 'Ö', 215: 'x', 216: 'O', 217: 'Ù', 218: 'U', 219: 'Û', 220: 'Ü', 221: 'Y', 222: 'T', 223: 'sz', 224: 'à', 225: 'a', 226: 'â', 227: 'a', 228: 'ä', 229: 'a', 230: 'ae', 231: 'ç', 232: 'è', 233: 'é', 234: 'ê', 235: 'ë', 236: 'i', 237: 'i', 238: 'î', 239: 'ï', 240: 'e', 241: 'n', 242: 'o', 243: 'o', 244: 'ô', 245: 'o', 246: 'ö', 248: 'o', 249: 'ù', 250: 'u', 251: 'û', 252: 'ü', 253: 'y', 255: 'ÿ'}
-
- -
-
-data = ''
-
- -
-
-entitydefs = {'Yacute': 'Y', 'otilde': 'o', 'icirc': 'î', 'oacute': 'o', 'aacute': 'a', 'egrave': 'è', 'nbsp': ' ', 'Ograve': 'O', 'lt': '<', 'AElig': 'AE', 'iacute': 'i', 'Ucirc': 'Û', 'apos': "'", 'Ocirc': 'Ô', 'Otilde': 'O', 'agrave': 'à', 'aring': 'a', 'Iacute': 'I', 'Iuml': 'I', 'ugrave': 'ù', 'Uacute': 'U', 'Ouml': 'Ö', 'Auml': 'Ä', 'atilde': 'a', 'ouml': 'ö', 'Ugrave': 'Ù', 'ecirc': 'ê', 'quot': '"', 'iuml': 'ï', 'Uuml': 'Ü', 'Aring': 'A', 'amp': '&', 'Oacute': 'O', 'ograve': 'o', 'ntilde': 'n', 'ucirc': 'û', 'oslash': 'o', 'THORN': 'T', 'ccedil': 'ç', 'ocirc': 'ô', 'thorn': 't', 'Acirc': 'Â', 'yacute': 'y', 'igrave': 'i', 'uacute': 'u', 'euml': 'ë', 'Aacute': 'A', 'yuml': 'ÿ', 'Euml': 'Ë', 'gt': '>', 'Atilde': 'A', 'Igrave': 'I', 'Ntilde': 'N', 'Agrave': 'À', 'aelig': 'ae', 'eacute': 'é', 'Icirc': 'I', 'Oslash': 'O', 'Eacute': 'È', 'Ccedil': 'Ç', 'auml': 'ä', 'Egrave': 'É', 'Ecirc': 'Ê', 'uuml': 'ü', 'acirc': 'â'}
-
- -
-
-handle_charref(name)
-
- -
-
-handle_data(data)
-
- -
-
-handle_endtag(tag)
-
- -
-
-handle_entityref(name)
-
- -
-
-handle_starttag(tag, attrs)
-
- -
- -
-
-pyams_utils.html.html_to_text(value)
-

Utility function to extract text content from HTML

-
>>> from pyams_utils.html import html_to_text
->>> html = '''<p>This is a HTML text part.</p>'''
->>> html_to_text(html)
-'This is a HTML text part.\n'
-
-
-
>>> html = '''<p>This is text with french accents: <strong>é à è ù</strong></p>'''
->>> html_to_text(html)
-'This is text with french accents: é à è ù\n'
-
-
-

HTML parser should handle entities correctly:

-
>>> html = '''<div><p>Header</p><p>This is an &lt; &#242; &gt; entity.<br /></p></div>'''
->>> html_to_text(html)
-'Header\nThis is an < ò > entity.\n\n'
-
-
-
>>> html = '''<div><p>Header</p><p>This is an &lt;&nbsp;&#242;&nbsp;&gt; entity.<br /></p></div>'''
->>> html_to_text(html)
-'Header\nThis is an < ò > entity.\n\n'
-
-
-
- -
-
-

pyams_utils.i18n module

-
-
-pyams_utils.i18n.get_browser_language(request)
-

Custom locale negotiator

-

Copied from zope.publisher code

-
- -
-
-pyams_utils.i18n.normalize_lang(lang)
-
- -
-
-

pyams_utils.include module

-
-
-pyams_utils.include.include_package(config)
-

Pyramid package include

-
- -
-
-

pyams_utils.intids module

-
-
-class pyams_utils.intids.UniqueIdAdapter(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Object unique ID adapter

-

This adapter is based on a registered IIntIds utility to get a unique ID -for any persistent object.

-
-
-oid
-

Get context ID in hexadecimal form

-
- -
- -
-
-pyams_utils.intids.handle_added_object(event)
-

Notify IntId utility for added objects

-

This subscriber is used for all persistent objects to be registered -in all locally registered IIntIds utilities.

-
- -
-
-pyams_utils.intids.handle_intid_event(event)
-

Event subscriber used to dispatch all IIntIdEvent events using Pyramid events subscribers to matching -subscribers using Zope events

-
- -
-
-pyams_utils.intids.handle_removed_object(event)
-

Notify IntId utility for removed objects

-

This subscriber is used for all persistent objects to be unregistered -from all locally registered IIntIds utilities.

-
- -
-
-

pyams_utils.list module

-
-
-pyams_utils.list.unique(seq, idfun=None)
-

Extract unique values from list, preserving order

- --- - - - - - -
Parameters:
    -
  • seq (iterator) – input list
    • -
  • idfun (callable) – an identity function which is used to get ‘identity’ value of each element -in the list
    • -
-
Returns:

list; a new list containing only unique elements of the original list in their initial order. -Original list is not modified.

-
-
>>> from pyams_utils.list import unique
->>> mylist = [1, 2, 3, 2, 1]
->>> unique(mylist)
-[1, 2, 3]
-
-
-
>>> mylist = [3, 2, 2, 1, 4, 2]
->>> unique(mylist)
-[3, 2, 1, 4]
-
-
-

You can also set an ‘id’ function applied on each element:

-
>>> mylist = [1, 2, 3, '2', 4]
->>> unique(mylist, idfun=str)
-[1, 2, 3, 4]
-
-
-
- -
-
-

pyams_utils.lock module

-
-
-class pyams_utils.lock.CacheLock(name, wait=True)
-

Bases: object

-

Beaker based lock

-

This lock can be used when you need to get a lot across several processes or even computers. -The lock relies on a shared value stored into a shared Beaker cache.

- --- - - - -
Parameters:
    -
  • name (str) – name of the lock to use as shared key
    • -
  • wait (boolean) – if False, a LockException is raised if lock can’t be taken; otherwise, -application waits until lock is released
    • -
-
-

Lock can be used as a context manager.

-
- -
-
-exception pyams_utils.lock.LockException
-

Bases: Exception

-

Cache lock exception

-
- -
-
-pyams_utils.lock.get_locks_cache()
-

Get locks shared cache

-
- -
-
-pyams_utils.lock.locked(name, wait=True)
-

Locked function decorator

-

Can be used with any function or method which requires a global shared lock.

- --- - - - -
Parameters:
    -
  • name (str) – name of the lock to use as shared key
    • -
  • wait (boolean) – if False, a LockException is raised if lock can’t be taken; otherwise, -application waits until lock is released
    • -
-
-
- -
-
-

pyams_utils.progress module

-
-
-pyams_utils.progress.get_progress_cache()
-

Get cache storing tasks progress

-
- -
-
-pyams_utils.progress.get_progress_status_view(request)
-

Get progress status of a given task

-

Each submitted task is identified by an ID defined when the task is created

-
- -
-
-pyams_utils.progress.get_running_tasks()
-

Get list of running tasks

-
- -
-
-pyams_utils.progress.get_tasks_cache()
-

Get cache storing tasks list

-
- -
-
-pyams_utils.progress.set_running_tasks(tasks)
-

Update list of running tasks

-
- -
-
-

pyams_utils.property module

-
-
-class pyams_utils.property.DocFieldProperty(field, name=None)
-

Bases: zope.schema.fieldproperty.FieldProperty

-
- -
-
-class pyams_utils.property.cached(function)
-

Bases: object

-

Custom property decorator to define a property or function which is calculated only once

-

When applied on a function, caching is based on input arguments

-
-
-expire(*args)
-
- -
- -
-
-class pyams_utils.property.cached_property(fget, doc=None)
-

Bases: object

-

A read-only property decorator that is only evaluated once.

-

The value is cached on the object itself rather than the function or class; this should prevent -memory leakage.

-
- -
-
-class pyams_utils.property.classproperty(fget=None, fset=None, fdel=None, doc=None)
-

Bases: object

-

Same decorator as property(), but passes obj.__class__ instead of obj to fget/fset/fdel.

-

Original code for property emulation: -https://docs.python.org/3.5/howto/descriptor.html#properties

-
-
-deleter(fdel)
-
- -
-
-getter(fget)
-
- -
-
-setter(fset)
-
- -
- -
-
-pyams_utils.property.classproperty_support(cls)
-

Class decorator to add metaclass to a class.

-

Metaclass uses to add descriptors to class attributes

-
- -
-
-

pyams_utils.registry module

-

Local registry management package

-

This package is used to manage local registry. A local registry is a site management component -created automatically on application startup by PyAMS_utils package. It can be used to store and register -components, mainly utilities which are created and configured dynamically by a site administrator; this can include -SQLAlchemy engines, ZEO connections, and several PyAMS utilities like security manager, medias converter, -tasks scheduler and many other ones.

-

See Managing ZCA with PyAMS to get a brief introduction about using a local registry with PyAMS packages.

-
-
-class pyams_utils.registry.LocalRegistry
-

Bases: _thread._local

-

Local registry

-
-
-get_registry()
-
- -
-
-set_registry(registry)
-
- -
- -
-
-pyams_utils.registry.get_all_utilities_registered_for(interface)
-

Get list of registered utilities for given interface

-

Do a registry lookup for matching utilities into local registry first, then on each registry -associated with current thread stack.

-
- -
-
-pyams_utils.registry.get_current_registry(context=None)
-

Get current or global registry

-
- -
-
-pyams_utils.registry.get_global_registry()
-

Get global registry

-
- -
-
-pyams_utils.registry.get_local_registry()
-

Get local registry

-
- -
-
-pyams_utils.registry.get_registries()
-

Iterator on components registries

-

Returns an iterator on current local registry (if any) and registries associated -in current thread stack.

-
- -
-
-pyams_utils.registry.get_utilities_for(interface)
-

Get utilities registered with given interface as (name, util) tuples iterator

-

Do a registry lookup for matching utilities into local registry first, then on each registry -associated with current thread stack.

-
- -
-
-pyams_utils.registry.get_utility(provided, name='')
-

Get utility registered with given interface

-

Do a registry lookup for given utility into local registry first, then on each registry -associated with current thread stack.

- --- - - - - - -
Parameters:
    -
  • provided (Interface) – the requested interface
    • -
  • name (str) – name of the requested utility
    • -
-
Returns:

object; the requested object. A ComponentLookupError is raised if the utility -can’t be found.

-
-
- -
-
-pyams_utils.registry.handle_new_request(event)
-

New request event subscriber

-

Is used to initialize local registry to None for any new request

-
- -
-
-pyams_utils.registry.handle_site_before_traverse(event)
-

Before traverse event subscriber

-

Define site’s local registry when an object implementing ISite is traversed

-
- -
-
-pyams_utils.registry.query_utility(provided, name='', default=None)
-

Query utility registered with given interface

-

Do a registry lookup for given utility into local registry first, then on each registry -associated with current thread stack.

- --- - - - - - -
Parameters:
    -
  • provided (Interface) – the requested interface
    • -
  • name (str) – name of the requested utility
    • -
  • default (object) – the default object returned if the requested utility can’t be found
    • -
-
Returns:

object; the requested object, or default if it can’t be found

-
-
- -
-
-pyams_utils.registry.registered_utilities()
-

Get utilities registrations as generator

-

Iterates over utilities defined in all registries, starting with local ones.

-
- -
-
-pyams_utils.registry.set_local_registry(registry)
-

Define local registry

-
- -
-
-class pyams_utils.registry.utility_config(**settings)
-

Bases: object

-

Function or class decorator to register a utility in the global registry

- --- - - - -
Parameters:
    -
  • name (str) – default=’‘; name under which the utility is registered
    • -
  • provides (Interface) – the interface for which the utility is registered
    • -
-
-

Please note that a single utility can be registered several times (using several annotations).

-
-
-venusian = <module 'venusian' from '/var/local/env/pyams/eggs/venusian-1.1.0-py3.5.egg/venusian/__init__.py'>
-
- -
- -
-
-

pyams_utils.request module

-
-
-class pyams_utils.request.PyAMSRequest(environ, charset=None, unicode_errors=None, decode_param_names=None, **kw)
-

Bases: pyramid.request.Request

-

Custom request factory

-

Used to add ‘context’ argument to ‘effective_principals’ method call -to be able to get ‘roles’ principals

-
-
-has_permission(x, *args, **kwargs)
-
- -
- -
-
-pyams_utils.request.check_request(path='/', environ=None, base_url=None, headers=None, POST=None, **kw)
-

Get current request, or create a new blank one if missing

-
- -
-
-pyams_utils.request.get_annotations(request)
-

Define ‘annotations’ request property

-

This function is automatically defined as a custom request method on package include.

-
- -
-
-pyams_utils.request.get_debug(request)
-

Define ‘debug’ request property

-

This function is automatically defined as a custom request method on package include.

-
- -
-
-pyams_utils.request.get_request(raise_exception=True)
-

Get current request

-

Raises a NoInteraction exception if there is no active request.

-
- -
-
-pyams_utils.request.get_request_data(request, key, default=None)
-

Get data associated with request

- --- - - - - - -
Parameters:
    -
  • request – the request containing requested data
    • -
  • key (str) – request data annotation key
    • -
  • default (object) – the default value when data is missing
    • -
-
Returns:

the requested value, or default

-
-
- -
-
-pyams_utils.request.query_request()
-

Query current request

-

Returns None if there is no active request

-
- -
-
-pyams_utils.request.request_property(key=None, prefix=None)
-

Define a method decorator used to store result into current request’s annotations

-

If no request is currently running, a new one is created. -key is a required argument; if None, the key will be the method’s object

- --- - - - -
Parameters:
    -
  • key (str) – annotations value key; if None, the key will be the method’s object; if key is a callable -object, it will be called to get the actual session key
    • -
  • prefix – str; prefix to use for session key; if None, the prefix will be the property name
    • -
-
-
- -
-
-pyams_utils.request.set_request_data(request, key, value)
-

Associate data with request

- --- - - - -
Parameters:
    -
  • request – the request in which to set data
    • -
  • key (str) – request data annotation key
    • -
  • value (object) – the value to be set in request annotation
    • -
-
-
- -
-
-

pyams_utils.schema module

-
-
-class pyams_utils.schema.ColorField(*args, **kw)
-

Bases: zope.schema._bootstrapfields.TextLine

-

Color field

-
- -
-
-class pyams_utils.schema.DatesRangeField(value_type=None, unique=False, **kw)
-

Bases: zope.schema._field.Tuple

-

Dates range field

-
- -
-
-class pyams_utils.schema.DottedDecimalField(*args, **kw)
-

Bases: zope.schema._field.Decimal

-

Dotted decimal field

-
- -
-
-class pyams_utils.schema.EncodedPassword(*args, **kw)
-

Bases: zope.schema._bootstrapfields.Password

-

Encoded password field

-
-
-constraint(value)
-
- -
-
-fromUnicode(str)
-
- -
- -
-
-class pyams_utils.schema.HTMLField(*args, **kw)
-

Bases: zope.schema._bootstrapfields.Text

-

HTML field

-
- -
-
-exception pyams_utils.schema.InvalidEmail
-

Bases: zope.schema._bootstrapinterfaces.ValidationError

-

Email address must be entered as « name@domain.name », without ‘<’ and ‘>’ characters

-
- -
-
-class pyams_utils.schema.MailAddressField(*args, **kw)
-

Bases: zope.schema._bootstrapfields.TextLine

-

Mail address field

-
- -
-
-class pyams_utils.schema.PersistentDict(key_type=None, value_type=None, **kw)
-

Bases: zope.schema._field.Dict

-

Persistent mapping field

-
- -
-
-class pyams_utils.schema.PersistentList(value_type=None, unique=False, **kw)
-

Bases: zope.schema._field.List

-

Persistent list field

-
- -
-
-class pyams_utils.schema.TextLineListField(value_type=None, unique=False, **kw)
-

Bases: zope.schema._field.List

-

TextLine list field

-
- -
-
-

pyams_utils.session module

-
-
-pyams_utils.session.get_session_data(request, app, key, default=None)
-

Get data associated with current user session

-

PyAMS session management is based on Beaker package session management.

- --- - - - -
Parameters:
    -
  • request – the request from which session is extracted
    • -
  • app (str) – application name
    • -
  • key (str) – session data key for given application
    • -
  • default – object; requested session data, or default if it can’t be found
    • -
-
-
APPLICATION_KEY = 'MyApp'
-SESSION_KEY = 'MyFunction'
-
-def my_function(request):
-    return get_session_data(request, APPLICATION_KEY, SESSION_KEY)
-
-
-
- -
-
-pyams_utils.session.session_property(app, key=None, prefix=None)
-

Define a method decorator used to store result into request’s session

-

If no request is currently running, a new one is created.

- --- - - - -
Parameters:
    -
  • app (str) – application identifier used to prefix session keys
    • -
  • key (str) – session’s value key; if None, the key will be the method’s object; if key is a callable -object, il will be called to get the actual session key
    • -
  • prefix – str; prefix to use for session key; if None, the prefix will be the property name
    • -
-
-
- -
-
-pyams_utils.session.set_session_data(request, app, key, value)
-

Associate data with current user session

- --- - - - -
Parameters:
    -
  • request – the request from which session is extracted
    • -
  • app (str) – application name
    • -
  • key (str) – session data key for given application
    • -
  • value (object) – any object that can be pickled can be stored into user session
    • -
-
-
APPLICATION_KEY = 'MyApp'
-SESSION_KEY = 'MyFunction'
-
-def my_function(request):
-    value = {'key1': 'value1', 'key2': 'value2'}
-    set_session_data(request, APPLICATION_KEY, SESSION_KEY, value)
-
-
-
- -
-
-

pyams_utils.site module

-
-
-class pyams_utils.site.BaseSiteRoot
-

Bases: zope.container.folder.Folder, zope.site.site.SiteManagerContainer

-

Default site root

-

A site root can be used as base application root in your ZODB. -It’s also site root responsibility to manage your local site manager.

-

BaseSiteRoot defines a basic ACL which gives all permissions to system administrator.

-
-
-config_klass = None
-
- -
- -
-
-class pyams_utils.site.NewLocalSiteCreatedEvent(object)
-

Bases: zope.interface.interfaces.ObjectEvent

-

New local site creation event

-
- -
-
-class pyams_utils.site.SiteRootEtcTraverser(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Site root ++etc++ namespace traverser

-

Gives access to local site manager from /++etc++site URL

-
-
-traverse(name, furtherpath=None)
-
- -
- -
-
-class pyams_utils.site.SiteUpgradeEvent(object)
-

Bases: zope.interface.interfaces.ObjectEvent

-

Site upgrade request event

-
- -
-
-pyams_utils.site.check_required_utilities(site, utilities)
-

Utility function to check for required utilities

- --- - - - -
Parameters:
    -
  • site (object) – the site manager into which configuration may be checked
    • -
  • utilities (tuple) – each element of the tuple is another tuple made of the utility interface, -the utility registration name, the utility factory and the object name when creating the utility, as in:
    • -
-
-
REQUIRED_UTILITIES = ((ISecurityManager, '', SecurityManager, 'Security manager'),
-                      (IPrincipalAnnotationUtility, '', PrincipalAnnotationUtility, 'User profiles'))
-
-
-
- -
-
-pyams_utils.site.site_factory(request)
-

Application site factory

-

On application startup, this factory checks configuration to get application name and -load it from the ZODB; if the application can’t be found, configuration is scanned to -get application factory, create a new one and create a local site manager.

-
- -
-
-pyams_utils.site.site_upgrade(request)
-

Upgrade site when needed

-

This function is executed by pyams_upgrade console script. -Site generations are registered named utilities providing -ISiteGenerations interface.

-

Current site generations are stored into annotations for each generation adapter.

-
- -
-
-

pyams_utils.size module

-
-
-pyams_utils.size.get_human_size(value, request=None)
-

Convert given bytes value in human readable format

-
>>> from pyramid.testing import DummyRequest
->>> request = DummyRequest(params={'_LOCALE_': 'en'})
->>> request.locale_name
-'en'
->>> from pyams_utils.size import get_human_size
->>> get_human_size(256, request)
-'256 bytes'
->>> get_human_size(3678, request)
-'3.6 Kb'
->>> get_human_size(6785342, request)
-'6.47 Mb'
->>> get_human_size(3674815342, request)
-'3.422 Gb'
->>> request = DummyRequest(params={'_LOCALE_': 'fr'})
->>> request.locale_name
-'fr'
->>> get_human_size(256, request)
-'256 bytes'
->>> get_human_size(3678, request)
-'3,6 Kb'
->>> get_human_size(6785342, request)
-'6,47 Mb'
->>> get_human_size(3674815342, request)
-'3,422 Gb'
-
-
-
- -
-
-

pyams_utils.tales module

-
-
-class pyams_utils.tales.ContextExprMixin
-

Bases: object

-

Mixin-class for expression compilers

-
-
-transform = None
-
- -
- -
-
-class pyams_utils.tales.ExtensionExpr(expression, braces_required=False)
-

Bases: pyams_utils.tales.ContextExprMixin, chameleon.tales.StringExpr

-

extension: TALES expression

-

This expression can be used to call a custom named adapter providing ITALESExtension interface.

-
-
-transform = <Symbol value=<function render_extension> at 7f1fadbcfa20>
-
- -
- -
-
-pyams_utils.tales.render_extension(econtext, name)
-

TALES extension renderer

-

See Custom TALES extensions for complete description.

-
- -
-
-

pyams_utils.text module

-
-
-class pyams_utils.text.BaseHTMLRenderer(context, request)
-

Bases: object

-

Raw text HTML renderer

-

This renderer renders input text ‘as is’, mainly for use in a <pre> tag.

-
-
-render(**kwargs)
-
- -
- -
-
-class pyams_utils.text.HTMLTalesExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:html TALES expression

-

If first context argument of the renderer is an object for which an IHTMLRenderer -adapter can be found, this adapter is used to render the context to HTML; if context is a string, -it is converted to HTML using the renderer defined as second parameter; otherwise, context is just -converted to string using the str() function.

-
-
-render(context=None, renderer='text')
-
- -
- -
-
-class pyams_utils.text.ReStructuredTextRenderer(context, request)
-

Bases: pyams_utils.text.BaseHTMLRenderer

-

reStructuredText HTML renderer

-

This renderer is using docutils to render HTML output.

-
-
-render(**kwargs)
-

Render reStructuredText to HTML

-
- -
- -
-
-class pyams_utils.text.RenderersVocabulary
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

Text renderers vocabulary

-
- -
-
-class pyams_utils.text.TextRenderer(context, request)
-

Bases: pyams_utils.text.BaseHTMLRenderer

-

Basic text HTML renderer

-

This renderer only replace newlines with HTML breaks.

-
-
-render(**kwargs)
-
- -
- -
-
-pyams_utils.text.get_text_start(text, length, max=0)
-

Get first words of given text with maximum given length

-

If max is specified, text is shortened only if remaining text is longer this value

- --- - - - -
Parameters:
    -
  • text (str) – initial text
    • -
  • length (integer) – maximum length of resulting text
    • -
  • max (integer) – if > 0, text is shortened only if remaining text is longer than max
    • -
-
-
>>> from pyams_utils.text import get_text_start
->>> get_text_start('This is a long string', 10)
-'This is a&#133;'
->>> get_text_start('This is a long string', 20)
-'This is a long&#133;'
->>> get_text_start('This is a long string', 20, 7)
-'This is a long string'
-
-
-
- -
-
-pyams_utils.text.text_to_html(text, renderer='text')
-

Convert text to HTML using the given renderer

-

Renderer name can be any registered HTML renderer adapter

-
- -
-
-

pyams_utils.traversing module

-
-
-class pyams_utils.traversing.NamespaceTraverser(root)
-

Bases: pyramid.traversal.ResourceTreeTraverser

-

Custom traverser handling views and namespaces

-

This is an upgraded version of native Pyramid traverser. -It adds: -- a new BeforeTraverseEvent before traversing each object in the path -- support for namespaces with “++” notation

-
-
-NAMESPACE_SELECTOR = '++'
-
- -
- -
-
-class pyams_utils.traversing.PathElementsAdapter(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Contained object path elements adapter

-

This interface is intended to be used inside a keyword index to -be able to search object based on a given parent

-
-
-parents
-
- -
- -
-
-pyams_utils.traversing.get_parent(context, interface=<InterfaceClass zope.interface.Interface>, allow_context=True, condition=None)
-

Get first parent of the context that implements given interface

- --- - - - -
Parameters:
    -
  • context (object) – base element
    • -
  • interface (Interface) – the interface that parend should implement
    • -
  • allow_context (boolean) – if ‘True’ (the default), traversing is done starting with context; otherwise, -traversing is done starting from context’s parent
    • -
  • condition (callable) – an optional function that should return a ‘True’ result when called with parent -as first argument
    • -
-
-
- -
-
-

pyams_utils.unicode module

-
-
-pyams_utils.unicode.decode(value, encoding='utf-8')
-

Decode given bytes value to unicode with given encoding

- --- - - - - - -
Parameters:
    -
  • value (bytes) – the value to decode
    • -
  • encoding (str) – selected encoding
    • -
-
Returns:

str; value decoded to unicode string if input is a bytes, original value otherwise

-
-
>>> from pyams_utils.unicode import decode
->>> decode(b'Cha\xc3\xaene accentu\xc3\xa9e')
-'Chaîne accentuée'
->>> decode(b'Cha\xeene accentu\xe9e', 'latin1')
-'Chaîne accentuée'
-
-
-
- -
-
-pyams_utils.unicode.encode(value, encoding='utf-8')
-

Encode given Unicode value to bytes with given encoding

- --- - - - - - -
Parameters:
    -
  • value (str) – the value to encode
    • -
  • encoding (str) – selected encoding
    • -
-
Returns:

bytes; value encoded to bytes if input is a string, original value otherwise

-
-
>>> from pyams_utils.unicode import encode
->>> encode('Chaîne accentuée')
-b'Cha\xc3\xaene accentu\xc3\xa9e'
->>> encode('Chaîne accentuée', 'latin1')
-b'Cha\xeene accentu\xe9e'
-
-
-
- -
-
-pyams_utils.unicode.nvl(value, default='')
-

Get specified value, or an empty string if value is empty

- --- - - - - - -
Parameters:
    -
  • value (object) – value to be checked
    • -
  • default (object) – default value to be returned if value is false
    • -
-
Returns:

input value, or default if value is false

-
-
>>> from pyams_utils.unicode import nvl
->>> nvl(None)
-''
->>> nvl('foo')
-'foo'
->>> nvl(False, 'bar')
-'bar'
-
-
-
- -
-
-pyams_utils.unicode.translate_string(s, escape_slashes=False, force_lower=True, spaces=' ', remove_punctuation=True, keep_chars='_-.')
-

Remove extended characters and diacritics from string and replace them with ‘basic’ ones

- --- - - - - - -
Parameters:
    -
  • s (str) – text to be cleaned.
    • -
  • escape_slashes (boolean) – if True, slashes are also converted
    • -
  • force_lower (boolean) – if True, result is automatically converted to lower case
    • -
  • spaces (str) – character used to replace spaces
    • -
  • remove_punctuation (boolean) – if True, all punctuation characters are removed
    • -
  • keep_chars (str) – characters which may be kept in the input string
    • -
-
Returns:

text without diacritics or special characters

-
-
>>> from pyams_utils.unicode import translate_string
->>> input = 'Ceci est un test en Français !!!'
->>> translate_string(input)
-'ceci est un test en francais'
->>> translate_string(input, force_lower=False)
-'Ceci est un test en Francais'
->>> translate_string(input, spaces='-')
-'ceci-est-un-test-en-francais'
->>> translate_string(input, remove_punctuation=False)
-'ceci est un test en francais !!!'
->>> translate_string(input, keep_chars='!')
-'ceci est un test en francais !!!'
-
-
-
- -
-
-pyams_utils.unicode.unidict(value, encoding='utf-8')
-

Get specified dict with values converted to unicode

- --- - - - - - -
Parameters:value (dict) – input mapping of strings which may be converted to unicode
Returns:dict; a new mapping with each value converted to unicode
-
>>> from pyams_utils.unicode import unidict
->>> unidict({'input': b'Cha\xc3\xaene accentu\xc3\xa9e'})
-{'input': 'Chaîne accentuée'}
->>> unidict({'input': b'Cha\xeene accentu\xe9e'}, 'latin1')
-{'input': 'Chaîne accentuée'}
-
-
-
- -
-
-pyams_utils.unicode.unilist(value, encoding='utf-8')
-

Get specified list with values converted to unicode

- --- - - - - - -
Parameters:value (list) – input list of strings which may be converted to unicode
Returns:list; a new list with each value converted to unicode
-
>>> from pyams_utils.unicode import unilist
->>> unilist([b'Cha\xc3\xaene accentu\xc3\xa9e'])
-['Chaîne accentuée']
->>> unilist([b'Cha\xeene accentu\xe9e'], 'latin1')
-['Chaîne accentuée']
-
-
-
- -
-
-pyams_utils.unicode.uninvl(value, default='', encoding='utf-8')
-

Get specified value converted to unicode, or an empty unicode string if value is empty

- --- - - - - - -
Parameters:
    -
  • value (str/bytes) – the input to be checked
    • -
  • default – str; default value
    • -
  • encoding – str; encoding name to use for conversion
    • -
-
Returns:

str; value, or default if value is empty, converted to unicode

-
-
>>> from pyams_utils.unicode import uninvl
->>> uninvl('String value')
-'String value'
->>> uninvl(b'String value')
-'String value'
->>> uninvl(b'Cha\xc3\xaene accentu\xc3\xa9e')
-'Chaîne accentuée'
->>> uninvl(b'Cha\xeene accentu\xe9e', 'latin1')
-'Chaîne accentuée'
-
-
-
- -
-
-pyams_utils.unicode.utf8(value)
-

Encode given unicode value to UTF-8 encoded bytes

- --- - - - - - -
Parameters:value (str) – the value to encode to utf-8
Returns:bytes; value encoded to bytes if input is a string, original value otherwise
-
>>> from pyams_utils.unicode import utf8
->>> utf8('Chaîne accentuée')
-b'Cha\xc3\xaene accentu\xc3\xa9e'
-
-
-
- -
-
-

pyams_utils.url module

-
-
-class pyams_utils.url.AbsoluteUrlTalesExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:absolute_url(context, view_name) TALES extension

-

A PyAMS TALES extension used to get access to an object URL from a page template.

-
-
-render(context=None, view_name=None)
-
- -
- -
-
-pyams_utils.url.absolute_url(context, request, view_name=None, query=None)
-

Get resource absolute_url

- --- - - - -
Parameters:
    -
  • context (object) – the persistent object for which absolute URL is required
    • -
  • request – the request on which URL is based
    • -
  • view_name (str) – an optional view name to add to URL
    • -
  • query (str/dict) – an optional URL arguments string or mapping
    • -
-
-

This absolute URL function is based on default Pyramid’s resource_url() function, but -add checks to remove some double slashes, and add control on view name when it begins with a ‘#’ -character which is used by MyAMS.js framework.

-
- -
-
-

pyams_utils.vocabulary module

-
-
-class pyams_utils.vocabulary.vocabulary_config(name)
-

Bases: object

-

Class decorator to define a vocabulary

- --- - - - -
Parameters:name (str) – name of the registered vocabulary
-

This is, for example, how a vocabulary of registered ZEO connections utilities is created:

-
from pyams_utils.interfaces.zeo import IZEOConnection
-
-from pyams_utils.registry import get_utilities_for
-from pyams_utils.vocabulary import vocabulary_config
-from zope.schema.vocabulary import SimpleTerm, SimpleVocabulary
-
-@vocabulary_config(name='PyAMS ZEO connections')
-class ZEOConnectionVocabulary(SimpleVocabulary):
-    '''ZEO connections vocabulary'''
-
-    def __init__(self, context=None):
-        terms = [SimpleTerm(name, title=util.name) for name, util in get_utilities_for(IZEOConnection)]
-        super(ZEOConnectionVocabulary, self).__init__(terms)
-
-
-

You can then use such a vocabulary in any schema field:

-
from zope.interface import Interface
-from zope.schema import Choice
-
-class MySchema(Interface):
-    '''Custom schema interface'''
-
-    zeo_connection_name = Choice(title='ZEO connection name',
-                                 description='Please select a registered ZEO connection',
-                                 vocabulary='PyAMS ZEO connections',
-                                 required=False)
-
-
-
- -
-
-

pyams_utils.wsgi module

-
-
-pyams_utils.wsgi.wsgi_environ_cache(*names)
-

Wrap a function/method to cache its result for call into request.environ

- --- - - - -
Parameters:names ([string...]) – keys to cache into environ; len(names) must -be equal to the result’s length or scalar
-
- -
-
-

pyams_utils.zodb module

-
-
-class pyams_utils.zodb.ZEOConnection
-

Bases: object

-

ZEO connection object

-

This object can be used to store all settings to be able to open a ZEO connection. -Note that this class is required only for tasks specifically targeting a ZEO database connection (like a ZEO -packer scheduler task); for generic ZODB operations, just use a ZODBConnection class defined through -Pyramid’s configuration file.

-

Note that a ZEO connection object is a context manager, so you can use it like this:

-
from pyams_utils.zodb import ZEOConnection
-
-def my_method(zeo_settings):
-    zeo_connection = ZEOConnection()
-    zeo_connection.update(zeo_settings)
-    with zeo_connection as root:
-        # *root* is then the ZODB root object
-        # do whatever you want with ZEO connection,
-        # which is closed automatically
-
-
-
-
-blob_dir
-

BLOBs directory: Directory path for blob data

-
- -
-
-connection
-
- -
-
-get_connection(wait=False, get_storage=False)
-

Create ZEO client connection from current settings

- --- - - - - - -
Parameters:
    -
  • wait (boolean) – should connection wait until storage is ready
    • -
  • get_storage (boolean) – if True, the method should return a tuple containing -storage and DB objects; otherwise only DB object is returned
    • -
-
Returns:

tuple containing ZEO client storage and DB object (if get_storage argument is -set to True), or only DB object otherwise

-
-
- -
-
-get_settings()
-

Get mapping of all connection settings

-

These settings can be converted to JSON and sent to another process, for example -via a ØMQ connection.

- --- - - - -
Returns:dict
-
- -
-
-name
-

Connection name: Registration name of ZEO connection

-
- -
-
-password
-

ZEO password: User password on ZEO server

-
- -
-
-server_name
-

ZEO server name: Hostname of ZEO server

-
- -
-
-server_port
-

ZEO server port: Port number of ZEO server

-
- -
-
-server_realm
-

ZEO server realm: Realm name on ZEO server

-
- -
-
-shared_blob_dir
-

Shared BLOBs directory ?: Flag whether the blob_dir is a server-shared filesystem that should be used instead of transferring blob data over zrpc.

-
- -
-
-storage
-

ZEO server storage: Storage name on ZEO server

-
- -
-
-update(settings)
-

Update connection properties with settings as dict

- --- - - - -
Parameters:settings (dict) – typically extracted via the get_settings() method from -another process
-
- -
-
-username
-

ZEO user name: User name on ZEO server

-
- -
- -
-
-class pyams_utils.zodb.ZEOConnectionUtility
-

Bases: pyams_utils.zodb.ZEOConnection, persistent.Persistent, zope.container.contained.Contained

-

Persistent ZEO connection utility

-
- -
-
-class pyams_utils.zodb.ZEOConnectionVocabulary(context=None)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

ZEO connections vocabulary

-
- -
-
-class pyams_utils.zodb.ZODBConnection(name='', settings=None)
-

Bases: object

-

ZODB connection wrapper

-

Connections are extracted from Pyramid’s settings file in zodbconn.uri entries.

-

Note that a ZODB connection object is a context manager, so you can use it like this:

-
from pyams_utils.zodb import ZODBConnection
-
-def my_method(zodb_name):
-    zodb_connection = ZODBConnection(zodb_name)
-    with zodb_connection as root:
-        # *root* is then the ZODB root object
-        # do whatever you want with ZODB connection,
-        # which is closed automatically
-
-
-
-
-close()
-
- -
-
-connection
-
- -
-
-db
-
- -
-
-get_connection()
-

Load named connection matching registry settings

-
- -
-
-storage
-
- -
- -
-
-class pyams_utils.zodb.ZODBConnectionVocabulary(context=None)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

ZODB connections vocabulary

-
- -
-
-pyams_utils.zodb.get_connection_from_settings(settings=None)
-

Load connection matching registry settings

-
- -
-
-pyams_utils.zodb.handle_added_connection(event)
-

Register new ZEO connection when added

-
- -
-
-pyams_utils.zodb.handle_removed_connection(event)
-

Un-register ZEO connection when deleted

-
- -
-
-pyams_utils.zodb.object_key_adapter(obj)
-
- -
-
-pyams_utils.zodb.persistent_connection(obj)
-

An adapter which gets a ZODB connection from a persistent object

-

We are assuming the object has a parent if it has been created in -this transaction.

-

Raises ValueError if it is impossible to get a connection.

-
- -
-
-pyams_utils.zodb.persistent_transaction_manager(obj)
-
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_utils.interfaces.html --- a/src/build/html/pyams_utils.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,237 +0,0 @@ - - - - - - - pyams_utils.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_utils.interfaces package

-
-

Module contents

-
-
-pyams_utils.interfaces.FORBIDDEN_PERMISSION = 'system.forbidden'
-

Custom permission which is never granted to any user

-
- -
-
-pyams_utils.interfaces.MANAGE_PERMISSION = 'manage'
-

Permission used to manage basic information; this permission is generally not used by custom contents

-
- -
-
-pyams_utils.interfaces.MANAGE_ROLES_PERMISSION = 'pyams.ManageRoles'
-

Permission used to manage roles

-
- -
-
-pyams_utils.interfaces.MANAGE_SECURITY_PERMISSION = 'pyams.ManageSecurity'
-

Permission used to manage security settings

-
- -
-
-pyams_utils.interfaces.MANAGE_SKIN_PERMISSION = 'pyams.ManageSkin'
-

Permission used to manage skin

-
- -
-
-pyams_utils.interfaces.MANAGE_SYSTEM_PERMISSION = 'pyams.ManageSystem'
-

Permission used to manage system settings

-
- -
-
-exception pyams_utils.interfaces.MissingRequestError
-

Bases: Exception

-

Error raised when no request is available

-
- -
-
-pyams_utils.interfaces.PUBLIC_PERMISSION = 'public'
-

Public permission which is granted to every principal

-
- -
-
-pyams_utils.interfaces.PYAMS_APPLICATION_DEFAULT_NAME = 'application'
-

ZODB default application name

-
- -
-
-pyams_utils.interfaces.PYAMS_APPLICATION_FACTORY_KEY = 'pyams.application_factory'
-

Settings key to define site root factory

-
- -
-
-pyams_utils.interfaces.PYAMS_APPLICATION_SETTINGS_KEY = 'pyams.application_name'
-

ZODB application name settings key

-
- -
-
-pyams_utils.interfaces.VIEW_PERMISSION = 'view'
-

View permission is a custom permission used to view contents

-
- -
-
-pyams_utils.interfaces.VIEW_SYSTEM_PERMISSION = 'pyams.ViewSystem'
-

Permission used to access management screens

-
- -
-
-

Submodules

-
-

pyams_utils.interfaces.data module

-
-
-

pyams_utils.interfaces.intids module

-
-
-

pyams_utils.interfaces.site module

-
-
-

pyams_utils.interfaces.size module

-
-
-

pyams_utils.interfaces.tales module

-
-
-

pyams_utils.interfaces.text module

-
-
-

pyams_utils.interfaces.timezone module

-
-
-class pyams_utils.interfaces.timezone.Timezone(**kw)
-

Bases: zope.schema._field.Choice

-

Timezone choice field

-
- -
-
-

pyams_utils.interfaces.traversing module

-
-
-

pyams_utils.interfaces.tree module

-
-
-

pyams_utils.interfaces.zeo module

-
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_utils.protocol.html --- a/src/build/html/pyams_utils.protocol.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,243 +0,0 @@ - - - - - - - pyams_utils.protocol package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_utils.protocol package

-
-

Module contents

-
-
-

Submodules

-
-

pyams_utils.protocol.http module

-
-
-class pyams_utils.protocol.http.HTTPClient(method, protocol, servername, url, params={}, credentials=(), proxy=(), rdns=True, proxy_auth=(), timeout=None, headers={})
-

Bases: object

-

HTTP client with proxy support

-
-
-get_response()
-

Common HTTP request

-
- -
- -
-
-pyams_utils.protocol.http.get_client(method, protocol, servername, url, params={}, credentials=(), proxy=(), rdns=True, proxy_auth=(), timeout=None, headers={})
-

HTTP client factory

-
- -
-
-pyams_utils.protocol.http.get_client_from_url(url, credentials=(), proxy=(), rdns=True, proxy_auth=(), timeout=None, headers={})
-

HTTP client factory from URL

-
- -
-
-

pyams_utils.protocol.xmlrpc module

-
-
-class pyams_utils.protocol.xmlrpc.SecureXMLRPCCookieAuthTransport(user_agent, credentials=(), cookies=None, timeout=<object object>, headers=None)
-

Bases: pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport

-

Secure XML-RPC transport

-
- -
-
-class pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport(user_agent, credentials=(), cookies=None, timeout=<object object>, headers=None)
-

Bases: xmlrpc.client.Transport

-

An XML-RPC transport handling authentication via cookies

-
-
-class CookieRequest(url, data=None, headers={}, origin_req_host=None, unverifiable=False, method=None)
-

Bases: urllib.request.Request

-
- -
-
-class CookieResponse(response)
-

Bases: object

-
-
-info()
-
- -
- -
-
-class CookieResponseHelper(response)
-

Bases: object

-
-
-getheaders(header)
-
- -
- -
-
-get_response(connection, host, handler)
-
- -
-
-make_connection(host)
-
- -
-
-request(host, handler, request_body, verbose=False)
-
- -
-
-send_auth(connection)
-
- -
-
-send_content_type(connection)
-
- -
-
-send_headers(connection, headers)
-
- -
-
-send_request(host, handler, request_body, debug)
-
- -
-
-send_user_agent(connection)
-
- -
-
-verbose = False
-
- -
- -
-
-pyams_utils.protocol.xmlrpc.get_client(uri, credentials=(), verbose=False, allow_none=0, timeout=<object object>, headers=None)
-

Get an XML-RPC client which supports basic authentication

-
- -
-
-pyams_utils.protocol.xmlrpc.get_client_with_cookies(uri, credentials=(), verbose=False, allow_none=0, timeout=<object object>, headers=None, cookies=None)
-

Get an XML-RPC client which supports authentication through cookies

-
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_utils.scripts.html --- a/src/build/html/pyams_utils.scripts.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,121 +0,0 @@ - - - - - - - pyams_utils.scripts package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_utils.scripts package

-
-

Module contents

-
-
-

Submodules

-
-

pyams_utils.scripts.zodb module

-
-
-pyams_utils.scripts.zodb.upgrade_site()
-

Check for site upgrade

-
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_utils.tests.html --- a/src/build/html/pyams_utils.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,145 +0,0 @@ - - - - - - - pyams_utils.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_utils.tests package

-
-

Module contents

-
-
-

Submodules

-
-

pyams_utils.tests.test_utilsdocs module

-

Generic Test case for ztfy.utils doctest

-
-
-pyams_utils.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_utils.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_utils.tests.test_utilsdocstrings module

-

Generic Test case for pyams_utils doc strings

-
-
-pyams_utils.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_utils.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_utils.timezone.html --- a/src/build/html/pyams_utils.timezone.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,199 +0,0 @@ - - - - - - - pyams_utils.timezone package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_utils.timezone package

-
-

Module contents

-
-
-pyams_utils.timezone.gmtime(value)
-

Convert datetime to GMT

-

Value is assumed to be in GMT if no timezone is given

-
- -
-
-pyams_utils.timezone.localgmtime(value)
-

Convert datetime to GMT

-

Value is assumed to be in server timezone if none is given

-
- -
-
-pyams_utils.timezone.tzinfo(request=None)
-

request to timezone adapter

-

There is no easy way to get timezone from a request. -This adapter assumes that the timezone is given by -a registered utility…

-
- -
-
-pyams_utils.timezone.tztime(value)
-

Convert datetime to local timezone

- --- - - - -
Parameters:value (datetime) – input datetime; value is assumed to be in GMT if no timezone is given
-
- -
-
-

Submodules

-
-

pyams_utils.timezone.utility module

-
-
-class pyams_utils.timezone.utility.ServerTimezoneUtility
-

Bases: persistent.Persistent, zope.container.contained.Contained

-
-
-timezone
-

Server timezone: Default server timezone

-
- -
- -
-
-class pyams_utils.timezone.utility.TimezoneGenerationsChecker
-

Bases: object

-

Timezone generations checker

-
-
-evolve(site, current=None)
-

Check for required utilities

-
- -
-
-generation = 1
-
- -
- -
-
-pyams_utils.timezone.utility.handle_new_local_site(event)
-

Create a new ServerTimezoneUtility when a site is created

-
- -
-
-

pyams_utils.timezone.vocabulary module

-
-
-class pyams_utils.timezone.vocabulary.TimezonesVocabulary(*args, **kw)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

Timezones vocabulary

-
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_utils.widget.html --- a/src/build/html/pyams_utils.widget.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,137 +0,0 @@ - - - - - - - pyams_utils.widget package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_utils.widget package

-
-

Module contents

-
-
-

Submodules

-
-

pyams_utils.widget.decimal module

-
-
-class pyams_utils.widget.decimal.DottedDecimalDataConverter(field, widget)
-

Bases: z3c.form.converter.BaseDataConverter

-

Dotted decimal field data converter

-
-
-errorMessage = 'The entered value is not a valid decimal literal.'
-
- -
-
-toFieldValue(value)
-
- -
-
-toWidgetValue(value)
-
- -
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_viewlet.html --- a/src/build/html/pyams_viewlet.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,404 +0,0 @@ - - - - - - - PyAMS viewlets — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

PyAMS viewlets

-
-

Module contents

-
-
-pyams_viewlet.includeme(config)
-

Pyramid include

-
- -
- -
-

Submodules

-
-

pyams_viewlet.manager module

-
-
-class pyams_viewlet.manager.ConditionalViewletManager(context, request, view)
-

Bases: pyams_viewlet.manager.WeightOrderedViewletManager

-

Conditional weight ordered viewlet managers.

-
-
-filter(viewlets)
-

Sort out all viewlets which are explicit not available

-

viewlets is a list of tuples of the form (name, viewlet).

-
- -
- -
-
-class pyams_viewlet.manager.TemplateBasedViewletManager
-

Bases: object

-

Template based viewlet manager mixin class

-
-
-template = <BoundViewTemplate of None>
-
- -
- -
-
-class pyams_viewlet.manager.ViewletManager(context, request, view)
-

Bases: object

-

The Viewlet Manager base

-

A generic manager class which can be instantiated

-
-
-filter(viewlets)
-

Sort out all content providers

-

viewlets is a list of tuples of the form (name, viewlet).

-
- -
-
-get(name, default=None)
-

See zope.interface.common.mapping.IReadMapping

-
- -
-
-permission = None
-
- -
-
-render()
-

See zope.contentprovider.interfaces.IContentProvider

-
- -
-
-sort(viewlets)
-

Sort the viewlets.

-

viewlets is a list of tuples of the form (name, viewlet).

-
- -
-
-template = None
-
- -
-
-update()
-

See zope.contentprovider.interfaces.IContentProvider

-
- -
- -
-
-pyams_viewlet.manager.ViewletManagerFactory(name, interface, bases=(), cdict=None)
-

Viewlet manager factory

-
- -
-
-class pyams_viewlet.manager.WeightOrderedViewletManager(context, request, view)
-

Bases: pyams_viewlet.manager.ViewletManager

-

Weight ordered viewlet managers.

-
-
-sort(viewlets)
-
- -
- -
-
-pyams_viewlet.manager.get_weight(item)
-
- -
-
-pyams_viewlet.manager.is_available(viewlet)
-
- -
-
-class pyams_viewlet.manager.viewletmanager_config(**settings)
-

Bases: object

-

Class or interface decorator used to declare a viewlet manager

-

You can provide same arguments as in ‘viewletManager’ ZCML directive: -@name = name of the viewlet; may be unique for a given viewlet manager -@view = the view class or interface for which viewlet is displayed -@for_ = the context class or interface for which viewlet is displayed -@permission = name of a permission required to display the viewlet -@layer = request interface required to display the viewlet -@class_ = the class handling the viewlet manager; if the decorator is applied

-
-
on an interface and if this argument is not provided, the viewlet manager -will be handled by a default ViewletManager class
-
-
@provides = an interface the viewlet manager provides; if the decorator is
-
applied on an Interface, this will be the decorated interface; if the -decorated is applied on a class and if this argument is not specified, -the manager will provide IViewletManager interface.
-
-
-
-venusian = <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'>
-
- -
- -
-
-

pyams_viewlet.metaconfigure module

-
-
-pyams_viewlet.metaconfigure.ViewletDirective(_context, name, class_, context=<InterfaceClass zope.interface.Interface>, layer=<InterfaceClass pyramid.interfaces.IRequest>, view=<InterfaceClass pyramid.interfaces.IView>, manager=<InterfaceClass pyams_viewlet.interfaces.IViewletManager>, attribute='render', permission=None, **kwargs)
-
- -
-
-pyams_viewlet.metaconfigure.ViewletManagerDirective(_context, name, context=<InterfaceClass zope.interface.Interface>, layer=<InterfaceClass pyramid.interfaces.IRequest>, view=<InterfaceClass pyramid.interfaces.IView>, provides=<InterfaceClass pyams_viewlet.interfaces.IViewletManager>, class_=None, permission=None)
-
- -
-
-

pyams_viewlet.metadirectives module

-
-
-

pyams_viewlet.provider module

-
-
-class pyams_viewlet.provider.ProviderExpr(expression, braces_required=False)
-

Bases: pyams_utils.tales.ContextExprMixin, chameleon.tales.StringExpr

-

provider: TALES expression

-
-
-transform = <Symbol value=<function render_content_provider> at 7fe785bf55c0>
-
- -
- -
-
-pyams_viewlet.provider.render_content_provider(econtext, name)
-
- -
-
-

pyams_viewlet.viewlet module

-
-
-class pyams_viewlet.viewlet.BaseContentProvider(context, request)
-

Bases: object

-

Base template based content provider

-
-
-permission = None
-
- -
-
-render = <BoundViewTemplate of None>
-
- -
-
-update()
-
- -
- -
-
-class pyams_viewlet.viewlet.ViewContentProvider(context, request, view)
-

Bases: pyams_viewlet.viewlet.BaseContentProvider

-

Template based content provider

-
- -
-
-class pyams_viewlet.viewlet.Viewlet(context, request, view, manager)
-

Bases: object

-

Viewlet adapter class used in meta directive as a mixin class.

-
-
-permission = None
-
- -
-
-render = <BoundViewTemplate of None>
-
- -
-
-update()
-
- -
- -
-
-class pyams_viewlet.viewlet.contentprovider_config(**settings)
-

Bases: object

-

Class decorator used to declare a content provider

-

You can provide same arguments as in ‘viewlet’ ZCML directive: -@name = name of the viewlet; may be unique for a given viewlet manager -@view = the view class or interface for which viewlet is displayed -@for = the context class or interface for which viewlet is displayed -@permission = name of a permission required to display the viewlet -@layer = request interface required to display the viewlet

-
-
-venusian = <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'>
-
- -
- -
-
-class pyams_viewlet.viewlet.viewlet_config(**settings)
-

Bases: object

-

Class decorator used to declare a viewlet

-

You can provide same arguments as in ‘viewlet’ ZCML directive: -@name = name of the viewlet; may be unique for a given viewlet manager -@manager = manager class or interface holding the viewlet -@view = the view class or interface for which viewlet is displayed -@for = the context class or interface for which viewlet is displayed -@permission = name of a permission required to display the viewlet -@layer = request interface required to display the viewlet -@weight = weight of the viewlet when using a weight ordered viewlet manager

-
-
-venusian = <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'>
-
- -
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_viewlet.tests.html --- a/src/build/html/pyams_viewlet.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_viewlet.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_viewlet.tests package

-
-

Submodules

-
-
-

pyams_viewlet.tests.test_utilsdocs module

-

Generic Test case for pyams_viewlet doctest

-
-
-pyams_viewlet.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_viewlet.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_viewlet.tests.test_utilsdocstrings module

-

Generic Test case for pyams_viewlet doc strings

-
-
-pyams_viewlet.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_viewlet.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_workflow.html --- a/src/build/html/pyams_workflow.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,653 +0,0 @@ - - - - - - - pyams_workflow package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_workflow package

- -
-

Submodules

-
-
-

pyams_workflow.content module

-
-
-class pyams_workflow.content.WorkflowContentDisplayedDateVocabulary(context)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

Workflow content displayed date vocabulary

-
- -
-
-class pyams_workflow.content.WorkflowContentPublicationInfo
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Workflow content info

-
-
-displayed_publication_date
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-first_publication_date
-
- -
-
-is_published(check_parent=True)
-
- -
-
-is_visible(request=None, check_parent=True)
-
- -
-
-publication
-
- -
-
-publication_date
-
- -
-
-publication_effective_date
-
- -
-
-publication_expiration_date
-
- -
-
-publisher
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-push_end_date
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-push_end_date_index
-
- -
-
-reset(complete=True)
-
- -
- -
-
-pyams_workflow.content.WorkflowContentPublicationInfoFactory(context)
-

Workflow content info factory

-
- -
-
-pyams_workflow.content.handle_cloned_object(event)
-

Add comment when an object is cloned

-
- -
-
-pyams_workflow.content.handle_cloned_publication_support(event)
-

Reset publication info when an object is cloned

-
- -
-
-

pyams_workflow.include module

-
-
-pyams_workflow.include.include_package(config)
-

Pyramid include

-
- -
-
-

pyams_workflow.versions module

-
-
-pyams_workflow.versions.WorkflowContentVersionsFactory(context)
-

Workflow versions factory

-
- -
-
-class pyams_workflow.versions.WorkflowHistoryItem(**kwargs)
-

Bases: persistent.Persistent

-

Workflow history item

-
-
-comment
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-date
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-principal
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-source_state
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-source_version
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-target_state
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-transition
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-transition_id
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_workflow.versions.WorkflowVersionState
-

Bases: persistent.Persistent

-

Workflow managed content version object

-
-
-get_first_state_date(states)
-
- -
-
-state
-
- -
-
-state_date
-
- -
-
-state_principal
-
- -
-
-state_urgency
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-version_id = None
-
- -
- -
-
-pyams_workflow.versions.WorkflowVersionStateFactory(context)
-

Workflow content version state factory

-
- -
-
-pyams_workflow.versions.WorkflowVersionVersionsFactory(context)
-

Workflow versions factory for version

-
- -
-
-class pyams_workflow.versions.WorkflowVersions
-

Bases: zope.container.folder.Folder

-

Workflow versions adapter

-
-
-add_version(content, state, principal=None)
-
- -
-
-get_last_versions(count=1)
-
- -
-
-get_version(version_id)
-
- -
-
-get_versions(states=None, sort=False, reverse=False)
-
- -
-
-has_version(states)
-
- -
-
-remove_version(version_id, state='deleted', comment=None, principal=None)
-
- -
-
-set_state(version_id, state, principal=None)
-
- -
- -
-
-class pyams_workflow.versions.WorkflowVersionsSublocations(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

Workflow versions sub-locations

-
-
-sublocations()
-
- -
- -
-
-class pyams_workflow.versions.WorkflowVersionsTraverser(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

++versions++ namespace traverser

-
-
-traverse(name, furtherpath=None)
-
- -
- -
-
-pyams_workflow.versions.handle_workflow_transition(event)
-

Handle workflow transition

-
- -
-
-pyams_workflow.versions.handle_workflow_version_transition(event)
-

Handle workflow version transition

-
- -
-
-

pyams_workflow.workflow module

-
-
-pyams_workflow.workflow.NullAction(wf, context)
-

Null action

-
- -
-
-pyams_workflow.workflow.NullCondition(wf, context)
-

Null condition

-
- -
-
-class pyams_workflow.workflow.Transition(transition_id, title, source, destination, condition=<function NullCondition>, action=<function NullAction>, trigger=0, permission=None, order=0, **user_data)
-

Bases: object

-

Transition object

-

A transition doesn’t make anything by itself. -Everything is handled by the workflow utility

-
- -
-
-class pyams_workflow.workflow.Workflow(transitions, states, initial_state=None, update_states=None, readonly_states=None, protected_states=None, manager_states=None, published_states=None, waiting_states=None, retired_states=None, archived_states=None, auto_retired_state=None)
-

Bases: object

-

Workflow utility

-
-
-get_state_label(state)
-
- -
-
-get_transition(source, transition_id)
-
- -
-
-get_transition_by_id(transition_id)
-
- -
-
-get_transitions(source)
-
- -
-
-refresh(transitions)
-
- -
- -
-
-class pyams_workflow.workflow.WorkflowInfo(context)
-

Bases: object

-

Workflow info adapter

-
-
-fire_automatic()
-
- -
-
-fire_transition(transition_id, comment=None, side_effect=None, check_security=True, principal=None)
-
- -
-
-fire_transition_for_versions(state, transition_id, comment=None, principal=None)
-
- -
-
-fire_transition_toward(state, comment=None, side_effect=None, check_security=True, principal=None)
-
- -
-
-get_automatic_transition_ids()
-
- -
-
-get_fireable_transition_ids(check_security=True)
-
- -
-
-get_fireable_transition_ids_toward(state, check_security=True)
-
- -
-
-get_manual_transition_ids(check_security=True)
-
- -
-
-get_system_transition_ids()
-
- -
-
-has_automatic_transitions()
-
- -
-
-has_version(state)
-
- -
-
-name
-
- -
-
-parent
-
- -
- -
-
-class pyams_workflow.workflow.WorkflowsVocabulary(context, **kw)
-

Bases: zope.componentvocabulary.vocabulary.UtilityVocabulary

-

Workflows vocabulary

-
-
-interface = <InterfaceClass pyams_workflow.interfaces.IWorkflow>
-
- -
-
-nameOnly = True
-
- -
- -
-
-pyams_workflow.workflow.granted_permission(permission, context)
-
- -
-
-

Module contents

-
-
-pyams_workflow.includeme(config)
-

Pyramid include

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_zmi.html --- a/src/build/html/pyams_zmi.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1155 +0,0 @@ - - - - - - - PyAMS management interface — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

PyAMS management interface

-
-

Module contents

-
-
-pyams_zmi.includeme(config)
-

Pyramid include

-
- -
- -
-

Submodules

-
-

pyams_zmi.admin module

-
-
-class pyams_zmi.admin.MainAdminPage
-

Bases: pyams_zmi.view.AdminView

-

Main administration page

-
- -
-
-

pyams_zmi.control_panel module

-
-
-class pyams_zmi.control_panel.GlobalRegistrationsHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Global registrations header adapter

-
-
-icon_class = 'fa fa-fw fa-codepen'
-
- -
- -
-
-class pyams_zmi.control_panel.GlobalRegistrationsHelpAdapter(context, request, view)
-

Bases: pyams_skin.help.ContentHelp

-

Global registrations help adapter

-
-
-header = 'Global registry utilities'
-
- -
-
-message = "The global registry groups local utilities as well as utilities registered outside\nsite's Object Database (ZODB).\n\nThese utilities are declared statically (generally using include or ZCML directives) and can't be setup\nwithout modifying site configuration."
-
- -
-
-message_format = 'rest'
-
- -
- -
-
-class pyams_zmi.control_panel.GlobalRegistrationsMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Global registrations menu

-
-
-label = 'Global registrations'
-
- -
-
-url = '#global-registrations.html'
-
- -
- -
-
-class pyams_zmi.control_panel.GlobalRegistrationsTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Utilities global registrations table

-
-
-data_attributes = {}
-
- -
-
-id = 'global_registrations_table'
-
- -
-
-title = 'Global utilities registrations'
-
- -
- -
-
-class pyams_zmi.control_panel.GlobalRegistrationsValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Global utilities values adapter

-
-
-values
-
- -
- -
-
-class pyams_zmi.control_panel.GlobalRegistrationsView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

-

Global registrations view

-
-
-table_class
-

alias of GlobalRegistrationsTable

-
- -
- -
-
-class pyams_zmi.control_panel.LocalRegistrationsHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Local registrations header adapter

-
-
-icon_class = 'fa fa-fw fa-codepen'
-
- -
- -
-
-class pyams_zmi.control_panel.LocalRegistrationsHelpAdapter(context, request, view)
-

Bases: pyams_skin.help.ContentHelp

-

Local registrations help adapter

-
-
-header = 'Local registry utilities'
-
- -
-
-message = "A local registry is a registry defining utilities stored into\nsite's Object Database (ZODB).\n\nYou can manage these utilities and modify their properties and site's behaviour without\nmodifying the application."
-
- -
-
-message_format = 'rest'
-
- -
- -
-
-class pyams_zmi.control_panel.LocalRegistrationsMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Local registrations menu

-
-
-label = 'Local registrations'
-
- -
-
-url = '#local-registrations.html'
-
- -
- -
-
-class pyams_zmi.control_panel.LocalRegistrationsTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Local utilities registrations table

-
-
-data_attributes = {}
-
- -
-
-id = 'local_registrations_table'
-
- -
-
-title = 'Local utilities registrations'
-
- -
- -
-
-class pyams_zmi.control_panel.LocalRegistrationsValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Local utilities values adapter

-
-
-values
-
- -
- -
-
-class pyams_zmi.control_panel.LocalRegistrationsView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

-

Registrations view

-
-
-table_class
-

alias of LocalRegistrationsTable

-
- -
- -
-
-class pyams_zmi.control_panel.RegistrationsComponentColumn(context, request, table)
-

Bases: z3c.table.column.GetAttrColumn

-

Registrations component column

-
-
-getValue(obj)
-
- -
-
-header
-
- -
-
-weight = 1
-
- -
- -
-
-class pyams_zmi.control_panel.RegistrationsInterfaceColumn(context, request, table)
-

Bases: z3c.table.column.GetAttrColumn

-

Registrations interface column

-
-
-getValue(obj)
-
- -
-
-header
-
- -
-
-weight = 5
-
- -
- -
-
-class pyams_zmi.control_panel.RegistrationsNameColumn(context, request, table)
-

Bases: z3c.table.column.GetAttrColumn

-

Registrations name column

-
-
-getValue(obj)
-
- -
-
-header
-
- -
-
-weight = 10
-
- -
- -
-
-class pyams_zmi.control_panel.UtilitiesHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Utilities header adapter

-
-
-icon_class = 'fa fa-fw fa-codepen'
-
- -
- -
-
-class pyams_zmi.control_panel.UtilitiesMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Utilities menu

-
-
-icon_class = 'fa-codepen'
-
- -
-
-label = 'Utilities'
-
- -
-
-url = '#utilities.html'
-
- -
- -
-
-class pyams_zmi.control_panel.UtilitiesTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Utilities table

-
-
-data_attributes
-
- -
-
-id = 'utilities_table'
-
- -
-
-title = 'Site utilities'
-
- -
- -
-
-class pyams_zmi.control_panel.UtilitiesTrashColumn(context, request, table)
-

Bases: pyams_skin.table.TrashColumn

-

Utilities trash column

-
-
-checker(col, x)
-
- -
-
-icon_hint = 'Delete utility'
-
- -
-
-permission = 'pyams.ManageSystem'
-
- -
- -
-
-class pyams_zmi.control_panel.UtilitiesValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Utilities values adapter

-
-
-values
-
- -
- -
-
-class pyams_zmi.control_panel.UtilitiesView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

-

Control panel view

-
-
-table_class
-

alias of UtilitiesTable

-
- -
- -
-
-pyams_zmi.control_panel.delete_utility(request)
-

Delete utility from site manager

-
- -
-
-

pyams_zmi.extension module

-
-
-class pyams_zmi.extension.GoogleAnalyticsPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.extension.GoogleAnalyticsPropertiesEditForm

-

Google Analytics properties edit form, JSON renderer

-
- -
-
-class pyams_zmi.extension.GoogleAnalyticsPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Google Analytics properties edit form

-
-
-ajax_handler = 'analytics-properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Update Google Analytics properties'
-
- -
- -
-
-class pyams_zmi.extension.GoogleAnalyticsPropertiesMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Google Analytics properties menu

-
-
-icon_class = 'fa-line-chart'
-
- -
-
-label = 'Google Analytics...'
-
- -
-
-modal_target = True
-
- -
-
-url = 'analytics-properties.html'
-
- -
- -
-
-class pyams_zmi.extension.GoogleTagManagerPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.extension.GoogleTagManagerPropertiesEditForm

-

Google Tag Manager properties edit form, JSON renderer

-
- -
-
-class pyams_zmi.extension.GoogleTagManagerPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Google Tag Manager properties edit form

-
-
-ajax_handler = 'tag-manager-properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Update Google Tag Manager properties'
-
- -
- -
-
-class pyams_zmi.extension.GoogleTagManagerPropertiesMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Google Tag Manager properties menu

-
-
-icon_class = 'fa-tags'
-
- -
-
-label = 'Google Tag Manager...'
-
- -
-
-modal_target = True
-
- -
-
-url = 'tag-manager-properties.html'
-
- -
- -
-
-class pyams_zmi.extension.UserReportPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.extension.UserReportPropertiesEditForm

-

UserReport properties edit form, JSON renderer

-
- -
-
-class pyams_zmi.extension.UserReportPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

UserReport properties edit form

-
-
-ajax_handler = 'user-report.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Update UserReport service properties'
-
- -
- -
-
-class pyams_zmi.extension.UserReportPropertiesMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

UserReport properties menu

-
-
-icon_class = 'fa-comments'
-
- -
-
-label = 'UserReport settings...'
-
- -
-
-modal_target = True
-
- -
-
-url = 'user-report.html'
-
- -
- -
-
-

pyams_zmi.form module

-
-
-class pyams_zmi.form.AdminAddForm(context, request)
-

Bases: pyams_form.form.AddForm, pyams_zmi.view.AdminView

-

Admin add form

-
- -
-
-class pyams_zmi.form.AdminDialogAddForm(context, request)
-

Bases: pyams_form.form.DialogAddForm, pyams_zmi.view.AdminView

-

Admin dialog add form

-
- -
-
-class pyams_zmi.form.AdminDialogDisplayForm(context, request)
-

Bases: pyams_form.form.DialogDisplayForm, pyams_zmi.view.AdminView

-

Admin dialog display form

-
- -
-
-class pyams_zmi.form.AdminDialogEditForm(context, request)
-

Bases: pyams_form.form.DialogEditForm, pyams_zmi.view.AdminView

-

Admin dialog edit form

-
- -
-
-class pyams_zmi.form.AdminDisplayForm(context, request)
-

Bases: pyams_form.form.DisplayForm, pyams_zmi.view.AdminView

-

Admin display form

-
- -
-
-class pyams_zmi.form.AdminEditForm(context, request)
-

Bases: pyams_form.form.EditForm, pyams_zmi.view.AdminView

-

Admin edit form

-
- -
-
-class pyams_zmi.form.InnerAdminAddForm(context, request, view=None)
-

Bases: pyams_form.form.InnerAddForm, pyams_zmi.view.AdminView

-

Inner admin add form

-
- -
-
-class pyams_zmi.form.InnerAdminDisplayForm(context, request, view=None)
-

Bases: pyams_form.form.InnerDisplayForm, pyams_zmi.view.AdminView

-

Inner admin display form

-
- -
-
-class pyams_zmi.form.InnerAdminEditForm(context, request, view=None)
-

Bases: pyams_form.form.InnerEditForm, pyams_zmi.view.AdminView

-

Inner admin edit form

-
- -
-
-

pyams_zmi.layer module

-
-
-

pyams_zmi.site module

-
-
-class pyams_zmi.site.BackOfficePropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.site.BackOfficePropertiesEditForm

-

Back-office properties edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_zmi.site.BackOfficePropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Back-office properties edit form

-
-
-ajax_handler = 'back-office-properties.json'
-
- -
-
-dialog_class = 'modal-large'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields
-
- -
-
-getContent()
-
- -
-
-legend = 'Update site back-office properties'
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_zmi.site.BackOfficePropertiesMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Back-office properties menu

-
-
-icon_class = 'fa-tachometer'
-
- -
-
-label = 'Back-office properties...'
-
- -
-
-modal_target = True
-
- -
-
-url = 'back-office-properties.html'
-
- -
- -
-
-class pyams_zmi.site.PropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.site.PropertiesEditForm

-

Properties edit form, AJAX renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_zmi.site.PropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminEditForm

-

Properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSystem'
-
- -
-
-fields
-
- -
-
-getContent()
-
- -
-
-legend = 'Update main site properties'
-
- -
- -
-
-class pyams_zmi.site.PropertiesEditFormHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Utilities header adapter

-
-
-icon_class = 'fa fa-fw fa-twitch'
-
- -
-
-title
-
- -
- -
-
-class pyams_zmi.site.PropertiesMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Properties menu

-
-
-icon_class = 'fa-edit'
-
- -
-
-label = 'Properties'
-
- -
-
-url = '#properties.html'
-
- -
- -
-
-class pyams_zmi.site.SiteRootTitleAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Site root title adapter

-
-
-title
-
- -
- -
-
-

pyams_zmi.skin module

-
-
-class pyams_zmi.skin.AdminSkin
-

Bases: object

-

PyAMS administration skin

-
-
-label = 'PyAMS management skin'
-
- -
-
-layer = <InterfaceClass pyams_zmi.layer.IAdminLayer>
-
- -
- -
-
-class pyams_zmi.skin.UserSkinnablePropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_zmi.skin.UserSkinnablePropertiesEditForm

-

User skin properties edit form, JSON renderer

-
- -
-
-class pyams_zmi.skin.UserSkinnablePropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

User skin properties edit form

-
-
-ajax_handler = 'user-skin-properties.json'
-
- -
-
-edit_permission = 'pyams.ManageSkin'
-
- -
-
-fields
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Graphic theme elements'
-
- -
- -
-
-class pyams_zmi.skin.UserSkinnablePropertiesMenuDivider(context, request, view, manager)
-

Bases: pyams_skin.viewlet.menu.MenuDivider

-

User skin properties menu divider

-
- -
-
-class pyams_zmi.skin.UserSkinnablePropertiesMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

User skin properties menu

-
-
-icon_class = 'fa-paint-brush'
-
- -
-
-label = 'Graphic theme...'
-
- -
-
-modal_target = True
-
- -
-
-url = 'user-skin-properties.html'
-
- -
- -
-
-

pyams_zmi.view module

-
-
-class pyams_zmi.view.AdminView
-

Bases: object

-

Base admin view

-
-
-layer = <InterfaceClass pyams_zmi.layer.IAdminLayer>
-
- -
- -
-
-class pyams_zmi.view.ContainerAdminView(context, request)
-

Bases: pyams_zmi.view.InnerAdminView

-

Container admin view

-
-
-table_class
-

alias of Table

-
- -
-
-update()
-
- -
- -
-
-class pyams_zmi.view.InnerAdminView
-

Bases: pyams_zmi.view.AdminView

-

Inner admin view

-
- -
-
-pyams_zmi.view.handle_admin_form(event)
-

Set skin for admin forms

-
- -
-
-pyams_zmi.view.handle_admin_view(event)
-

Set skin for admin views

-
- -
-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_zmq.html --- a/src/build/html/pyams_zmq.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,274 +0,0 @@ - - - - - - - pyams_zmq package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_zmq package

- -
-

Submodules

-
-
-

pyams_zmq.handler module

-
-
-class pyams_zmq.handler.ZMQMessageHandler(process, stream, stop, handler=None, json_load=-1)
-

Bases: object

-

Base class for message handlers for a pyams_zmq.process.Process.

-

Inheriting classes only need to implement a handler function for each -message type.

-
-
-handler = None
-
- -
- -
-
-

pyams_zmq.process module

-
-
-class pyams_zmq.process.ZMQProcess(bind_addr, handler)
-

Bases: multiprocessing.context.Process

-

This is the base for all processes and offers utility methods -for setup and creating new streams.

-
-
-context = None
-

The ØMQ Context instance.

-
- -
-
-exit(num, frame)
-
- -
-
-initStream()
-

Initialize response stream

-
- -
-
-loop = None
-

PyZMQ’s event loop (IOLoop).

-
- -
-
-run()
-

Sets up everything and starts the event loop.

-
- -
-
-setup()
-

Creates a context and an event loop for the process.

-
- -
-
-socket_type = 4
-
- -
-
-stop()
-

Stops the event loop.

-
- -
-
-stream(sock_type, addr, bind, callback=None, subscribe=b'')
-

Creates a ZMQStream.

- --- - - - - - -
Parameters:
    -
  • sock_type – The ØMQ socket type (e.g. zmq.REQ)
    • -
  • addr –

    Address to bind or connect to formatted as host:port, -(host, port) or host (bind to random port). -If bind is True, host may be:

    -
      -
    • the wild-card *, meaning all available interfaces,
      • -
    • the primary IPv4 address assigned to the interface, in its
      • -
    -

    numeric representation or -- the interface name as defined by the operating system.

    -

    If bind is False, host may be:

    -
      -
    • the DNS name of the peer or
      • -
    • the IPv4 address of the peer, in its numeric representation.
      • -
    -

    If addr is just a host name without a port and bind is -True, the socket will be bound to a random port.

    -
    • -
  • bind – Binds to addr if True or tries to connect to it -otherwise.
    • -
  • callback – A callback for -on_recv(), optional
    • -
  • subscribe – Subscription pattern for SUB sockets, optional, -defaults to b''.
    • -
-
Returns:

A tuple containg the stream and the port number.

-
-
- -
- -
-
-pyams_zmq.process.process_exit_func(process=None)
-
- -
-
-

pyams_zmq.socket module

-
-
-pyams_zmq.socket.zmq_response(socket, flags=1, timeout=10)
-

Get response from given socket

-
- -
-
-pyams_zmq.socket.zmq_socket(address, socket_type=3, linger=0, protocol='tcp')
-

Get ØMQ socket

-
- -
-
-

Module contents

-
-
-pyams_zmq.includeme(config)
-

Pyramid include

-
- -
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_zmq.interfaces.html --- a/src/build/html/pyams_zmq.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_zmq.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_zmq.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_zmq.tests.html --- a/src/build/html/pyams_zmq.tests.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ - - - - - - - pyams_zmq.tests package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_zmq.tests package

-
-

Submodules

-
-
-

pyams_zmq.tests.test_utilsdocs module

-

Generic Test case for pyams_zmq doctest

-
-
-pyams_zmq.tests.test_utilsdocs.doc_suite(test_dir, setUp=None, tearDown=None, globs=None)
-

Returns a test suite, based on doctests found in /doctest.

-
- -
-
-pyams_zmq.tests.test_utilsdocs.test_suite()
-

returns the test suite

-
- -
-
-

pyams_zmq.tests.test_utilsdocstrings module

-

Generic Test case for pyams_zmq doc strings

-
-
-pyams_zmq.tests.test_utilsdocstrings.doc_suite(test_dir, globs=None)
-

Returns a test suite, based on doc tests strings found in /*.py

-
- -
-
-pyams_zmq.tests.test_utilsdocstrings.test_suite()
-

returns the test suite

-
- -
-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/pyams_zodbbrowser.interfaces.html --- a/src/build/html/pyams_zodbbrowser.interfaces.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ - - - - - - - pyams_zodbbrowser.interfaces package — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

pyams_zodbbrowser.interfaces package

-
-

Module contents

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/site.html --- a/src/build/html/site.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,170 +0,0 @@ - - - - - - - PyAMS site management — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

PyAMS site management

-

PyAMS site management is based on the ZODB.

-

On application startup, if PyAMS_utils package is included into Pyramid configuration, several operations take -place:

-
-
    -
  • a custom site factory is defined
    • -
  • custom request methods are defined
    • -
  • a custom traverser handling namespaces is defined
    • -
  • a custom subscribers predicate based on interfaces support is defined
    • -
  • several adapters are registered, to handle annotations and key references
    • -
  • custom TALES extensions are registered.
    • -
-
-

The site factory is an important component in this process. It is this factory which will define the application root -and create a local site manager.

-

Pyramid application is loaded from ZODB’s root via a key defined in Pyramid’s configuration file; the key is named -pyams.application_name and it’s default value is application.

-

If the application can’t be found, PyAMS is looking for an application class name in Pyramid’s configuration file; the -class name configuration key is called pyams.application_factory and defined by default as -pyams_utils.site.BaseSiteRoot. PyAMS default site factory will then create the application, and add a local site -manager to it (see Managing ZCA with PyAMS).

-

After application creation, a NewLocalSiteCreatedEvent is -notified. Custom packages can subscribe to this event to register custom components.

-
-

pyams_upgrade command line script

-

Pyramid allows to define custom command line scripts for application management. A script called pyams_upgrade is -provided by PyAMS_utils package; this script apply the same process as PyAMS site factory, but can also be used to -manage database generations. The idea behind this is just to allow custom packages to provide a way to check and -upgrade database configuration away from application startup process:

-
# ./bin/pyams_upgrade webapp/development.ini
-
-
-

A site generation checker is just a named utility providing pyams_utils.interfaces.site.ISiteGenerations -interface. For example, pyams_security package provides such utility, to make sure that local site manager -contains a PyAMS security manager and a principal annotation utility:

-
from pyams_utils.site import check_required_utilities
-
-REQUIRED_UTILITIES = ((ISecurityManager, '', SecurityManager, 'Security manager'),
-                      (IPrincipalAnnotationUtility, '', PrincipalAnnotationUtility, 'User profiles'))
-
-@utility_config(name='PyAMS security', provides=ISiteGenerations)
-class SecurityGenerationsChecker(object):
-"""I18n generations checker"""
-
-    generation = 1
-
-    def evolve(self, site, current=None):
-        """Check for required utilities"""
-        check_required_utilities(site, REQUIRED_UTILITIES)
-
-
-

check_required_utilities is a PyAMS_utils utility function which -can to used to verify that a set of local utilities are correctly registered with the given names and interfaces.

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/build/html/zodb.html --- a/src/build/html/zodb.html Sun Jan 14 15:46:10 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,238 +0,0 @@ - - - - - - - Creating ZODB — PyAMS User Guide 0.1.0 documentation - - - - - - - - - - - - - - - - - - - -
-
-
-
- -
-

Creating ZODB

-

PyAMS primarily relies on a ZODB (Zope Objects DataBase) to store it’s configuration. Other packages may -rely on other database(s), but PyAMS_content package also stores it’s contents in a ZODB.

-

As some PyAMS packages start several processes (“synchronization” is done via ØMQ), concurrent accesses are -required on the ZODB (even when you start your application in “single process” mode); several ZODB storages -implementations providing a shared access are available: ZEO, RelStorage and Newt.DB.

-
-

Installing a ZEO server

-

ZEO (Zope Enterprise Objects) is the first available implementation available for concurrent access to a -FileStorage, provided through the ZEO package.

-

ZEO package documentation and complete configuration settings are available on PyPI.

-
-

Creating initial buildout

-

PyAMS provides a ZEO server scaffold, called zeo_server, generated via a cookiecutter template.

-

A simple option to create a ZEO server is to create a buildout environment including ZEO and ZODB packages:

-
# mkdir /var/local/
-# pip3 install virtualenv
-# virtualenv --python=python3.5 env
-# cd env
-# . bin/activate
-(env) # pip3.5 install cookiecutter
-(env) # cookiecutter hg+http://hg.ztfy.org/pyams/scaffolds/zeo_server
-
-
-

CookieCutter will ask you for a small set of input variables that you can change or not:

-
    -
  • pyams_release: version of PyAMS configuration file to use. “latest” (default value) will point to last release; -you can also choose to point to a given release (“0.1.4” for example)
    • -
  • project_name: current environment name in “human form”
    • -
  • project_slug: “technical” package name, based on project name
    • -
  • eggs_directory: relative or absolute path to directory containing downloaded eggs; this directory can be -shared with other projects (“eggs” as default)
    • -
  • run_user: user name under which ZEO process will run (“zeoadm” as default)
    • -
  • run_group: group name under which ZEO process will run (“zeo” as default)
    • -
  • zeo_server_port: listening port of ZEO server (“8100” as default)
    • -
  • zeo_monitor_port: listening port of ZEO monitor (“8101” as default)
    • -
  • zeo_storage: name of first ZEO storage; default value is based on project name
    • -
  • use_zeo_auth: specify if ZEO authentication should be used
    • -
  • zeo_auth_user: name of ZEO authenticated user (if ZEO authentication is used)
    • -
  • zeo_auth_password: password of ZEO authenticated user (if ZEO authentication is used)
    • -
  • zeo_pack_report: email address to which pack reports should be sent
    • -
  • logs_directory: absolute path to directory containing ZEO’s log files.
    • -
-

A message is displayed after initialization to finalize environment creation:

-
Your ZEO environment is initialized.
-To finalize it''s creation, just type:
-- cd zeo_server
-- python3.5 bootstrap.py
-- ./bin/buildout
-
-To initialize authentication database, please run following command after buildout:
-./bin/zeopasswd -f etc/auth.db -p digest -r "ZEO_server" zeouser xxxx
-
-
-
-
-

ZEO server configuration

-

All ZEO configuration files are generated in “etc” subdirectory. These includes:

-
    -
  • etc/zeo_server-zdaemon.conf: ZDaemon configuration file
    • -
  • etc/zeo_server-zeo.conf: ZEO server configuration file
    • -
  • etc/auth.db: ZEO authentication file; WARNING: this file is not created automatically, you have to create it -after buildout.
    • -
-

In these file names, always replace “zeo_server” with the value which was given to “project_slug” variable during -CookieCutter template creation.

-
-
-

ZEO server tools

-

A set of system configuration files are produced to handle your ZEO environment. These includes:

-
    -
  • etc/init.d/zeo-zeo_server: ZEO server start/stop script in Init-D format. Create a link to this file in -/etc/init.d and update Init.d scripts (update-rc.d zeo-zeo_server defaults) to include ZEO in server start/stop -process. You can also use this script to start/stop ZEO by hand with start and stop arguments.
    • -
  • etc/systemd/zeo-zeo_server.service: SystemD service configuration file for ZEO server. Create a link to this -file in /etc/systemd/system and reload SystemD daemon (systemctl daemon-reload) before activating ZEO service -(systemctl enable zeo-zeo_server.service and systemctl start zeo-zeo_server.service).
    • -
  • etc/logrotate.d/zeo-zeo_server: LogRotate configuration file for ZEO log files. Create a link to this file in -/etc/logrotate.d to activate log rotation for ZEO server.
    • -
  • etc/cron.d/pack-zeo-zeo_server: Cron configuration file for ZEO database packing. Just create a link to this -file in /etc/cron.d directory to enable ZODB packing on a weekly basis (by default).
    • -
-

In these file names, always replace “zeo_server” with the value which was given to “project_slug” variable during -CookieCutter template creation. All directory names are those used on a Debian GNU/Linux distribution and may have -to be changed on other distributions.

-
-
-
-

Installing a RelStorage server

-

RelStorage (http://relstorage.readthedocs.io/en/latest) is an alternate ZODB storage implementation, that stores -Python pickles in a relational database; PostgreSQL (>= 9.0), MySQL (>= 5.0.32) and Oracle (> 10g) databases are -supported.

-

To create a database compatible with RelStorage, you just have to install the database server and create a database -dedicated to RelStorage; schema initialization is then completely done by RelStorage on application startup.

-

RelStorage is supposed to provide better performances than ZEO, notably under high load. RelStorage can also get -benefit from many extensions (clustering, fail-over, hot-standby…) provided by these databases.

-
-
-

Installing a NewtDB server

-

NewtDB (http://www.newtdb.org/en/latest) is another ZODB storage implementation. It’s using RelStorage but is -dedicated to PostgreSQL (>= 9.5).

-

NewtDB adds conversion of data from the native serialization used by ZODB to JSON, stored in a PostgreSQL JSONB -column. The JSON data supplements the native data to support indexing, search, and access from non-Python application. -Because the JSON format is lossy, compared to the native format, the native format is still used for loading -objects from the database. For this reason, the JSON data are read-only.

-

Newt adds a search API for searching the Postgres JSON data and returning persistent objects. It also provides a -convenient API for raw data searches.

-

Database creation is done as with RelStorage, but NewtDB add several schema objects. Migration scripts are available -if you need to switch from a classic RelStorage database to a Newt database.

-
-
- - -
-
-
- -
-
- - - - \ No newline at end of file diff -r 562bde22e104 -r 1d12ff3f036a src/source/architecture.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/architecture.rst Mon Jan 15 16:45:01 2018 +0100 @@ -0,0 +1,4 @@ +.. _architecture: + +PyAMS application architecture +============================== diff -r 562bde22e104 -r 1d12ff3f036a src/source/modules.rst --- a/src/source/modules.rst Sun Jan 14 15:46:10 2018 +0100 +++ b/src/source/modules.rst Mon Jan 15 16:45:01 2018 +0100 @@ -12,6 +12,7 @@ pyams_utils pyams_skin pyams_form + pyams_file pyams_i18n pyams_security pyams_zmi diff -r 562bde22e104 -r 1d12ff3f036a src/source/pyams_file.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_file.rst Mon Jan 15 16:45:01 2018 +0100 @@ -0,0 +1,86 @@ +.. _pyams_file: + +PyAMS files and images utilities +================================ + + +Module contents ++++++++++++++++ + +.. automodule:: pyams_file + :members: + :undoc-members: + :show-inheritance: + + +Subpackages ++++++++++++ + +.. toctree:: + + pyams_file.archive + pyams_file.interfaces + pyams_file.tests + pyams_file.views + pyams_file.widget + pyams_file.zmi + + +Submodules +++++++++++ + +pyams\_file\.file module +------------------------ + +.. automodule:: pyams_file.file + :members: + :undoc-members: + :show-inheritance: + +pyams\_file\.image module +------------------------- + +.. automodule:: pyams_file.image + :members: + :undoc-members: + :show-inheritance: + +pyams\_file\.include module +--------------------------- + +.. automodule:: pyams_file.include + :members: + :undoc-members: + :show-inheritance: + +pyams\_file\.property module +---------------------------- + +.. automodule:: pyams_file.property + :members: + :undoc-members: + :show-inheritance: + +pyams\_file\.schema module +-------------------------- + +.. automodule:: pyams_file.schema + :members: + :undoc-members: + :show-inheritance: + +pyams\_file\.thumbnail module +----------------------------- + +.. automodule:: pyams_file.thumbnail + :members: + :undoc-members: + :show-inheritance: + +pyams\_file\.watermark module +----------------------------- + +.. automodule:: pyams_file.watermark + :members: + :undoc-members: + :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/source/pyams_file.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_file.tests.rst Mon Jan 15 16:45:01 2018 +0100 @@ -0,0 +1,30 @@ +pyams\_file\.tests package +========================== + +Submodules +---------- + +pyams\_file\.tests\.test\_utilsdocs module +------------------------------------------ + +.. automodule:: pyams_file.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams\_file\.tests\.test\_utilsdocstrings module +------------------------------------------------ + +.. automodule:: pyams_file.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_file.tests + :members: + :undoc-members: + :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/source/pyams_file.views.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_file.views.rst Mon Jan 15 16:45:01 2018 +0100 @@ -0,0 +1,22 @@ +pyams\_file\.views package +========================== + +Submodules +---------- + +pyams\_file\.views\.file module +------------------------------- + +.. automodule:: pyams_file.views.file + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_file.views + :members: + :undoc-members: + :show-inheritance: diff -r 562bde22e104 -r 1d12ff3f036a src/source/zodb.rst --- a/src/source/zodb.rst Sun Jan 14 15:46:10 2018 +0100 +++ b/src/source/zodb.rst Mon Jan 15 16:45:01 2018 +0100 @@ -50,21 +50,13 @@ - **eggs_directory**: relative or absolute path to directory containing downloaded eggs; this directory can be shared with other projects ("eggs" as default) -- **run_user**: user name under which ZEO process will run ("zeoadm" as default) +- **run_user**: user name under which ZEO process will run ("zeo" as default) - **run_group**: group name under which ZEO process will run ("zeo" as default) - **zeo_server_port**: listening port of ZEO server ("8100" as default) -- **zeo_monitor_port**: listening port of ZEO monitor ("8101" as default) - -- **zeo_storage**: name of first ZEO storage; default value is based on project name - -- **use_zeo_auth**: specify if ZEO authentication should be used - -- **zeo_auth_user**: name of ZEO authenticated user (if ZEO authentication is used) - -- **zeo_auth_password**: password of ZEO authenticated user (if ZEO authentication is used) +- **zeo_storage**: name of first ZEO storage ("pyams" as default) - **zeo_pack_report**: email address to which pack reports should be sent