# HG changeset patch # User Thierry Florac # Date 1424338142 -3600 # Node ID 31ded33115d7f18001254dd4a343cbb60195c7d1 First commit diff -r 000000000000 -r 31ded33115d7 .hgignore --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.hgignore Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,19 @@ + +syntax: regexp +^develop-eggs$ +syntax: regexp +^parts$ +syntax: regexp +^bin$ +syntax: regexp +^\.installed\.cfg$ +syntax: regexp +^\.settings$ +syntax: regexp +^build$ +syntax: regexp +^dist$ +syntax: regexp +^\.idea$ +syntax: regexp +.*\.pyc$ diff -r 000000000000 -r 31ded33115d7 .installed.cfg --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.installed.cfg Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,101 @@ +[buildout] +installed_develop_eggs = +parts = package i18n pyflakes test + +[package] +__buildout_installed__ = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/pcreate + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/proutes + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/pserve + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/pdistreport + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/pshell + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/prequest + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/ptweens + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/pviews +__buildout_signature__ = zc.recipe.egg-2.0.1-py3.4.egg setuptools-12.0.4-py3.4.egg zc.buildout-2.3.1-py3.4.egg +_b = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin +_d = /home/tflorac/Dropbox/src/PyAMS/pyams_template/develop-eggs +_e = /var/local/env/pyams/eggs +bin-directory = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin +develop-eggs-directory = /home/tflorac/Dropbox/src/PyAMS/pyams_template/develop-eggs +eggs = pyams_template + pyramid + zope.component + zope.interface +eggs-directory = /var/local/env/pyams/eggs +recipe = zc.recipe.egg + +[i18n] +__buildout_installed__ = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/pybabel + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/polint + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/pot-create +__buildout_signature__ = zc.recipe.egg-2.0.1-py3.4.egg setuptools-12.0.4-py3.4.egg zc.buildout-2.3.1-py3.4.egg +_b = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin +_d = /home/tflorac/Dropbox/src/PyAMS/pyams_template/develop-eggs +_e = /var/local/env/pyams/eggs +bin-directory = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin +develop-eggs-directory = /home/tflorac/Dropbox/src/PyAMS/pyams_template/develop-eggs +eggs = babel + lingua +eggs-directory = /var/local/env/pyams/eggs +recipe = zc.recipe.egg + +[pyflakes] +__buildout_installed__ = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/pyflakes + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/pyflakes +__buildout_signature__ = zc.recipe.egg-2.0.1-py3.4.egg setuptools-12.0.4-py3.4.egg zc.buildout-2.3.1-py3.4.egg +_b = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin +_d = /home/tflorac/Dropbox/src/PyAMS/pyams_template/develop-eggs +_e = /var/local/env/pyams/eggs +bin-directory = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin +develop-eggs-directory = /home/tflorac/Dropbox/src/PyAMS/pyams_template/develop-eggs +eggs = pyflakes +eggs-directory = /var/local/env/pyams/eggs +entry-points = pyflakes=pyflakes.scripts.pyflakes:main +initialization = if not sys.argv[1:]: sys.argv[1:] = ["src"] +recipe = zc.recipe.egg +scripts = pyflakes + +[test] +__buildout_installed__ = /home/tflorac/Dropbox/src/PyAMS/pyams_template/parts/test + /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/test +__buildout_signature__ = zc.recipe.testrunner-2.0.0-py3.4.egg zc.recipe.egg-2.0.1-py3.4.egg setuptools-12.0.4-py3.4.egg zope.testrunner-4.4.6-py3.4.egg zc.buildout-2.3.1-py3.4.egg zope.interface-4.1.2-py3.4-linux-x86_64.egg zope.exceptions-4.0.7-py3.4.egg six-45a2be65d681713a598787ec39be3290 +_b = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin +_d = /home/tflorac/Dropbox/src/PyAMS/pyams_template/develop-eggs +_e = /var/local/env/pyams/eggs +bin-directory = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin +develop-eggs-directory = /home/tflorac/Dropbox/src/PyAMS/pyams_template/develop-eggs +eggs = pyams_template [test] +eggs-directory = /var/local/env/pyams/eggs +location = /home/tflorac/Dropbox/src/PyAMS/pyams_template/parts/test +recipe = zc.recipe.testrunner +script = /home/tflorac/Dropbox/src/PyAMS/pyams_template/bin/test + +[buildout] +installed_develop_eggs = /home/tflorac/Dropbox/src/PyAMS/pyams_template/develop-eggs/pyams-template.egg-link + +[buildout] +parts = i18n pyflakes test package + +[buildout] +parts = pyflakes test package i18n + +[buildout] +parts = test package i18n pyflakes + +[buildout] +parts = package i18n pyflakes test + +[buildout] +installed_develop_eggs = /home/tflorac/Dropbox/src/PyAMS/pyams_template/develop-eggs/pyams-template.egg-link + +[buildout] +parts = i18n pyflakes test package + +[buildout] +parts = pyflakes test package i18n + +[buildout] +parts = test package i18n pyflakes + +[buildout] +parts = package i18n pyflakes test diff -r 000000000000 -r 31ded33115d7 LICENSE --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/LICENSE Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,42 @@ +Zope Public License (ZPL) Version 2.1 +===================================== + +A copyright notice accompanies this license document that identifies +the copyright holders. + +This license has been certified as open source. It has also been designated +as GPL compatible by the Free Software Foundation (FSF). + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + 1. Redistributions in source code must retain the accompanying copyright + notice, this list of conditions, and the following disclaimer. + 2. Redistributions in binary form must reproduce the accompanying copyright + notice, this list of conditions, and the following disclaimer in the + documentation and/or other materials provided with the distribution. + 3. Names of the copyright holders must not be used to endorse or promote + products derived from this software without prior written permission + from the copyright holders. + 4. The right to distribute this software or to use it for any purpose does + not give you the right to use Servicemarks (sm) or Trademarks (tm) of the + copyright holders. Use of them is covered by separate agreement with the + copyright holders. + 5. If any files are modified, you must cause the modified files to carry + prominent notices stating that you changed the files and the date of any + change. + + +Disclaimer +========== + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED +OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff -r 000000000000 -r 31ded33115d7 MANIFEST.in --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/MANIFEST.in Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,5 @@ +include *.txt +recursive-include docs * +recursive-include src * +global-exclude *.pyc +global-exclude *.*~ diff -r 000000000000 -r 31ded33115d7 bootstrap.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bootstrap.py Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,178 @@ +############################################################################## +# +# Copyright (c) 2006 Zope Foundation and Contributors. +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# +############################################################################## +"""Bootstrap a buildout-based project + +Simply run this script in a directory containing a buildout.cfg. +The script accepts buildout command-line options, so you can +use the -c option to specify an alternate configuration file. +""" + +import os +import shutil +import sys +import tempfile + +from optparse import OptionParser + +tmpeggs = tempfile.mkdtemp() + +usage = '''\ +[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options] + +Bootstraps a buildout-based project. + +Simply run this script in a directory containing a buildout.cfg, using the +Python that you want bin/buildout to use. + +Note that by using --find-links to point to local resources, you can keep +this script from going over the network. +''' + +parser = OptionParser(usage=usage) +parser.add_option("-v", "--version", help="use a specific zc.buildout version") + +parser.add_option("-t", "--accept-buildout-test-releases", + dest='accept_buildout_test_releases', + action="store_true", default=False, + help=("Normally, if you do not specify a --version, the " + "bootstrap script and buildout gets the newest " + "*final* versions of zc.buildout and its recipes and " + "extensions for you. If you use this flag, " + "bootstrap and buildout will get the newest releases " + "even if they are alphas or betas.")) +parser.add_option("-c", "--config-file", + help=("Specify the path to the buildout configuration " + "file to be used.")) +parser.add_option("-f", "--find-links", + help=("Specify a URL to search for buildout releases")) +parser.add_option("--allow-site-packages", + action="store_true", default=False, + help=("Let bootstrap.py use existing site packages")) + + +options, args = parser.parse_args() + +###################################################################### +# load/install setuptools + +try: + if options.allow_site_packages: + import setuptools + import pkg_resources + from urllib.request import urlopen +except ImportError: + from urllib2 import urlopen + +ez = {} +exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez) + +if not options.allow_site_packages: + # ez_setup imports site, which adds site packages + # this will remove them from the path to ensure that incompatible versions + # of setuptools are not in the path + import site + # inside a virtualenv, there is no 'getsitepackages'. + # We can't remove these reliably + if hasattr(site, 'getsitepackages'): + for sitepackage_path in site.getsitepackages(): + sys.path[:] = [x for x in sys.path if sitepackage_path not in x] + +setup_args = dict(to_dir=tmpeggs, download_delay=0) +ez['use_setuptools'](**setup_args) +import setuptools +import pkg_resources + +# This does not (always?) update the default working set. We will +# do it. +for path in sys.path: + if path not in pkg_resources.working_set.entries: + pkg_resources.working_set.add_entry(path) + +###################################################################### +# Install buildout + +ws = pkg_resources.working_set + +cmd = [sys.executable, '-c', + 'from setuptools.command.easy_install import main; main()', + '-mZqNxd', tmpeggs] + +find_links = os.environ.get( + 'bootstrap-testing-find-links', + options.find_links or + ('http://downloads.buildout.org/' + if options.accept_buildout_test_releases else None) + ) +if find_links: + cmd.extend(['-f', find_links]) + +setuptools_path = ws.find( + pkg_resources.Requirement.parse('setuptools')).location + +requirement = 'zc.buildout' +version = options.version +if version is None and not options.accept_buildout_test_releases: + # Figure out the most recent final version of zc.buildout. + import setuptools.package_index + _final_parts = '*final-', '*final' + + def _final_version(parsed_version): + for part in parsed_version: + if (part[:1] == '*') and (part not in _final_parts): + return False + return True + index = setuptools.package_index.PackageIndex( + search_path=[setuptools_path]) + if find_links: + index.add_find_links((find_links,)) + req = pkg_resources.Requirement.parse(requirement) + if index.obtain(req) is not None: + best = [] + bestv = None + for dist in index[req.project_name]: + distv = dist.parsed_version + if _final_version(distv): + if bestv is None or distv > bestv: + best = [dist] + bestv = distv + elif distv == bestv: + best.append(dist) + if best: + best.sort() + version = best[-1].version +if version: + requirement = '=='.join((requirement, version)) +cmd.append(requirement) + +import subprocess +if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0: + raise Exception( + "Failed to execute command:\n%s" % repr(cmd)[1:-1]) + +###################################################################### +# Import and run buildout + +ws.add_entry(tmpeggs) +ws.require(requirement) +import zc.buildout.buildout + +if not [a for a in args if '=' not in a]: + args.append('bootstrap') + +# if -c was provided, we push it back into args for buildout' main function +if options.config_file is not None: + args[0:0] = ['-c', options.config_file] + +zc.buildout.buildout.main(args) +shutil.rmtree(tmpeggs) diff -r 000000000000 -r 31ded33115d7 buildout.cfg --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/buildout.cfg Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,62 @@ +[buildout] +eggs-directory = /var/local/env/pyams/eggs + +socket-timeout = 3 +show-picked-versions = true +newest = false + +allow-hosts = + bitbucket.org + *.python.org + *.sourceforge.net + github.com + +#extends = http://download.ztfy.org/webapp/ztfy.webapp.dev.cfg +versions = versions +newest = false +#allow-picked-versions = false + +src = src +develop = . + +parts = + package + i18n + pyflakes + test + +[package] +recipe = zc.recipe.egg +eggs = + pyams_template + pyramid + pyramid_chameleon + zope.component + zope.configuration + zope.interface + zope.schema + +[i18n] +recipe = zc.recipe.egg +eggs = + babel + lingua + +[pyflakes] +recipe = zc.recipe.egg +eggs = pyflakes +scripts = pyflakes +entry-points = pyflakes=pyflakes.scripts.pyflakes:main +initialization = if not sys.argv[1:]: sys.argv[1:] = ["${buildout:src}"] + +[pyflakesrun] +recipe = collective.recipe.cmd +on_install = true +cmds = ${buildout:develop}/bin/${pyflakes:scripts} + +[test] +recipe = zc.recipe.testrunner +eggs = pyams_template [test] + +[versions] +pyams_template = 0.1.0 diff -r 000000000000 -r 31ded33115d7 docs/HISTORY.txt diff -r 000000000000 -r 31ded33115d7 docs/README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/README.txt Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,3 @@ +=============== +PyAMS Templates +=============== diff -r 000000000000 -r 31ded33115d7 setup.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/setup.py Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,72 @@ +### -*- coding: utf-8 -*- #################################################### +############################################################################## +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# +############################################################################## + +""" +This module contains pyams_template package +""" +import os +from setuptools import setup, find_packages + +DOCS = os.path.join(os.path.dirname(__file__), + 'docs') + +README = os.path.join(DOCS, 'README.txt') +HISTORY = os.path.join(DOCS, 'HISTORY.txt') + +version = '0.1.0' +long_description = open(README).read() + '\n\n' + open(HISTORY).read() + +tests_require = [] + +setup(name='pyams_template', + version=version, + description="PyAMS base template interfaces and classes", + long_description=long_description, + classifiers=[ + "License :: OSI Approved :: Zope Public License", + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Framework :: Pyramid", + "Topic :: Software Development :: Libraries :: Python Modules", + ], + keywords='Pyramid PyAMS template', + author='Thierry Florac', + author_email='tflorac@ulthar.net', + url='http://hg.ztfy.org/pyams/pyams_template', + license='ZPL', + packages=find_packages('src'), + package_dir={'': 'src'}, + namespace_packages=[], + include_package_data=True, + package_data={'': ['*.zcml', '*.txt', '*.pt', '*.pot', '*.po', '*.mo', '*.png', '*.gif', '*.jpeg', '*.jpg', '*.css', '*.js']}, + zip_safe=False, + # uncomment this to be able to run tests with setup.py + test_suite="pyams_template.tests.test_utilsdocs.test_suite", + tests_require=tests_require, + extras_require=dict(test=tests_require), + install_requires=[ + 'setuptools', + # -*- Extra requirements: -*- + 'pyramid', + 'pyramid_chameleon', + 'zope.component', + 'zope.configuration', + 'zope.interface', + 'zope.schema' + ], + entry_points=""" + # -*- Entry points: -*- + """, + ) diff -r 000000000000 -r 31ded33115d7 src/pyams_template.egg-info/PKG-INFO --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template.egg-info/PKG-INFO Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,21 @@ +Metadata-Version: 1.1 +Name: pyams-template +Version: 0.1.0 +Summary: PyAMS base template interfaces and classes +Home-page: http://hg.ztfy.org/pyams/pyams_template +Author: Thierry Florac +Author-email: tflorac@ulthar.net +License: ZPL +Description: =============== + PyAMS Templates + =============== + + + +Keywords: Pyramid PyAMS template +Platform: UNKNOWN +Classifier: License :: OSI Approved :: Zope Public License +Classifier: Development Status :: 4 - Beta +Classifier: Programming Language :: Python +Classifier: Framework :: Pyramid +Classifier: Topic :: Software Development :: Libraries :: Python Modules diff -r 000000000000 -r 31ded33115d7 src/pyams_template.egg-info/SOURCES.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template.egg-info/SOURCES.txt Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,23 @@ +MANIFEST.in +setup.py +docs/HISTORY.txt +docs/README.txt +src/pyams_template/__init__.py +src/pyams_template/configure.zcml +src/pyams_template/meta.zcml +src/pyams_template/metaconfigure.py +src/pyams_template/metadirectives.py +src/pyams_template/template.py +src/pyams_template.egg-info/PKG-INFO +src/pyams_template.egg-info/SOURCES.txt +src/pyams_template.egg-info/dependency_links.txt +src/pyams_template.egg-info/entry_points.txt +src/pyams_template.egg-info/namespace_packages.txt +src/pyams_template.egg-info/not-zip-safe +src/pyams_template.egg-info/requires.txt +src/pyams_template.egg-info/top_level.txt +src/pyams_template/doctests/README.txt +src/pyams_template/interfaces/__init__.py +src/pyams_template/tests/__init__.py +src/pyams_template/tests/test_utilsdocs.py +src/pyams_template/tests/test_utilsdocstrings.py \ No newline at end of file diff -r 000000000000 -r 31ded33115d7 src/pyams_template.egg-info/dependency_links.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template.egg-info/dependency_links.txt Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r 31ded33115d7 src/pyams_template.egg-info/entry_points.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template.egg-info/entry_points.txt Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,3 @@ + + # -*- Entry points: -*- + \ No newline at end of file diff -r 000000000000 -r 31ded33115d7 src/pyams_template.egg-info/namespace_packages.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template.egg-info/namespace_packages.txt Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r 31ded33115d7 src/pyams_template.egg-info/not-zip-safe --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template.egg-info/not-zip-safe Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r 31ded33115d7 src/pyams_template.egg-info/requires.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template.egg-info/requires.txt Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,9 @@ +setuptools +pyramid +pyramid_chameleon +zope.component +zope.configuration +zope.interface +zope.schema + +[test] diff -r 000000000000 -r 31ded33115d7 src/pyams_template.egg-info/top_level.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template.egg-info/top_level.txt Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,1 @@ +pyams_template diff -r 000000000000 -r 31ded33115d7 src/pyams_template/__init__.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/__init__.py Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,32 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + + +from pyramid.i18n import TranslationStringFactory +_ = TranslationStringFactory('pyams_template') + + +def includeme(config): + """Pyramid include""" + + # add translations + config.add_translation_dirs('pyams_template:locales') + + # define configuration settings + from pyams_template import template + template.configuration_settings = config.registry.settings + + # load registry components + config.scan() + + if hasattr(config, 'load_zcml'): + config.load_zcml('configure.zcml') diff -r 000000000000 -r 31ded33115d7 src/pyams_template/configure.zcml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/configure.zcml Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,8 @@ + + + + + + + diff -r 000000000000 -r 31ded33115d7 src/pyams_template/doctests/README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/doctests/README.txt Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,4 @@ +====================== +pyams_template package +====================== + diff -r 000000000000 -r 31ded33115d7 src/pyams_template/interfaces/__init__.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/interfaces/__init__.py Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,33 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +__docformat__ = 'restructuredtext' + + +# import standard packages + +# import interfaces +from zope.interface import Interface + +# import packages + + +class IPageTemplate(Interface): + """Base page template interface""" + + +class ILayoutTemplate(IPageTemplate): + """A template used for render the layout.""" + + +class IContentTemplate(IPageTemplate): + """A template used for render the content.""" diff -r 000000000000 -r 31ded33115d7 src/pyams_template/meta.zcml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/meta.zcml Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,20 @@ + + + + + + + + + + + + diff -r 000000000000 -r 31ded33115d7 src/pyams_template/metaconfigure.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/metaconfigure.py Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,65 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +__docformat__ = 'restructuredtext' + + +# import standard library +import os + +# import interfaces +from pyams_template.interfaces import ILayoutTemplate, IContentTemplate +from pyramid.interfaces import IRequest + +# import packages +from pyams_template.template import TemplateFactory +from pyramid.exceptions import ConfigurationError +from zope.component import zcml +from zope.interface import directlyProvides, Interface + + +def template_directive(_context, template, name=u'', + for_=Interface, + layer=IRequest, + provides=IContentTemplate, + contentType='text/html', + macro=None, + context=None): + # Make sure that the template exists + template = os.path.abspath(str(_context.path(template))) + if not os.path.isfile(template): + raise ConfigurationError("No such file", template) + + factory = TemplateFactory(template, contentType, macro) + directlyProvides(factory, provides) + + if context is not None: + for_ = (for_, layer, context) + else: + for_ = (for_, layer) + + # register the template + if name: + zcml.adapter(_context, (factory,), provides, for_, name=name) + else: + zcml.adapter(_context, (factory,), provides, for_) + + +def layout_template_directive(_context, template, name=u'', + for_=Interface, + layer=IRequest, + provides=ILayoutTemplate, + contentType='text/html', + macro=None, + context=None): + template_directive(_context, template, name, for_, layer, provides, + contentType, macro, context) diff -r 000000000000 -r 31ded33115d7 src/pyams_template/metadirectives.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/metadirectives.py Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,86 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +__docformat__ = 'restructuredtext' + + +# import standard library + +# import interfaces +from pyramid.interfaces import IRequest + +# import packages +from zope.configuration.fields import Path, GlobalObject, GlobalInterface +from zope.interface import Interface +from zope.schema import TextLine, ASCIILine +from pyams_template.interfaces import IContentTemplate, ILayoutTemplate + + +class ITemplateDirective(Interface): + """Parameters for the template directive.""" + + template = Path(title='Layout template.', + description="Refers to a file containing a page template (should " + "end in extension ``.pt`` or ``.html``).", + required=True) + + name = TextLine(title="The name of the template.", + description="The name is used to look up the template.", + default='', + required=False) + + macro = TextLine(title='Macro', + description=""" + The macro to be used. + This allows us to define different macros in one template. + The template designer can now create a whole site, the + ViewTemplate can then extract the macros for single viewlets + or views. + If no macro is given the whole template is used for rendering. + """, + default='', + required=False) + + for_ = GlobalObject(title='View', + description='The view for which the template should be available', + default=Interface, + required=False) + + layer = GlobalObject(title='Layer', + description='The layer for which the template should be available', + required=False, + default=IRequest) + + context = GlobalObject(title='Context', + description='The context for which the template should be available', + required=False) + + provides = GlobalInterface(title="Interface the template provides", + description="This attribute specifies the interface the template " + "instance will provide.", + default=IContentTemplate, + required=False) + + contentType = ASCIILine(title='Content Type', + description='The content type identifies the type of data.', + default='text/html', + required=False) + + +class ILayoutTemplateDirective(ITemplateDirective): + """Parameters for the layout template directive.""" + + provides = GlobalInterface(title="Interface the template provides", + description="This attribute specifies the interface the template " + "instance will provide.", + default=ILayoutTemplate, + required=False) diff -r 000000000000 -r 31ded33115d7 src/pyams_template/template.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/template.py Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,201 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +__docformat__ = 'restructuredtext' + + +# import standard library +import inspect +import os +import venusian + +# import interfaces +from pyams_template.interfaces import IPageTemplate, IContentTemplate, ILayoutTemplate +from pyramid.interfaces import IRequest +from pyramid_chameleon.interfaces import IChameleonTranslate + +# import packages +from pyramid.exceptions import ConfigurationError +from pyramid_chameleon.zpt import PyramidPageTemplateFile +from zope.component import queryUtility +from zope.interface import directlyProvides + + +configuration_settings = {} + + +class TemplateFactory(object): + """Template factory.""" + + template = None + + def __init__(self, filename, contentType, macro=None): + self.contentType = contentType + self.template = PyramidPageTemplateFile(filename, + content_type=contentType, + macro=macro, + auto_reload=configuration_settings.get('reload_templates', False), + debug=configuration_settings.get('debug_templates', False), + translate=queryUtility(IChameleonTranslate)) + self.macro = self.template.macro = macro + + def __call__(self, view, request, context=None): + return self.template + + +class BoundViewTemplate(object): + def __init__(self, pt, ob): + object.__setattr__(self, 'im_func', pt) + object.__setattr__(self, 'im_self', ob) + + def __call__(self, *args, **kw): + if self.im_self is None: + im_self, args = args[0], args[1:] + else: + im_self = self.im_self + return self.im_func(im_self, *args, **kw) + + def __setattr__(self, name, v): + raise AttributeError("Can't set attribute", name) + + def __repr__(self): + return "" % self.im_self + + +class ViewTemplate(object): + def __init__(self, provides=IPageTemplate, name=u''): + self.provides = provides + self.name = name + + def __call__(self, instance, *args, **keywords): + registry = instance.request.registry + template = registry.queryMultiAdapter((instance, instance.request, instance.context), + self.provides, name=self.name) + if template is None: + template = registry.getMultiAdapter((instance, instance.request), + self.provides, name=self.name) + + keywords.update({'context': instance.context, + 'request': instance.request, + 'view': instance, + 'translate': queryUtility(IChameleonTranslate)}) + return template(*args, **keywords) + + def __get__(self, instance, type): + return BoundViewTemplate(self, instance) + +get_view_template = ViewTemplate + + +class GetPageTemplate(ViewTemplate): + + def __init__(self, name=u''): + self.provides = IContentTemplate + self.name = name + +get_page_template = GetPageTemplate + + +class GetLayoutTemplate(ViewTemplate): + + def __init__(self, name=u''): + self.provides = ILayoutTemplate + self.name = name + +get_layout_template = GetLayoutTemplate + + +class template_config(object): + """Class decorator used to declare a template""" + + venusian = venusian # for testing injection + + def __init__(self, **settings): + if 'for_' in settings: + if settings.get('context') is None: + settings['context'] = settings['for_'] + self.__dict__.update(settings) + + def __call__(self, wrapped): + settings = self.__dict__.copy() + + def callback(context, name, ob): + template = os.path.join(os.path.dirname(inspect.getfile(inspect.getmodule(ob))), + settings.get('template')) + if not os.path.isfile(template): + raise ConfigurationError("No such file", template) + + contentType = settings.get('contentType', 'text/html') + macro = settings.get('macro') + factory = TemplateFactory(template, contentType, macro) + provides = settings.get('provides', IContentTemplate) + directlyProvides(factory, provides) + + config = context.config.with_package(info.module) + config.registry.registerAdapter(factory, + (ob, settings.get('layer', IRequest)), + provides, settings.get('name', '')) + + info = self.venusian.attach(wrapped, callback, category='pyams_pagelet') + + if info.scope == 'class': + # if the decorator was attached to a method in a class, or + # otherwise executed at class scope, we need to set an + # 'attr' into the settings if one isn't already in there + if settings.get('attr') is None: + settings['attr'] = wrapped.__name__ + + settings['_info'] = info.codeinfo # fbo "action_method" + return wrapped + + +class layout_config(object): + """Class decorator used to declare a template""" + + venusian = venusian # for testing injection + + def __init__(self, **settings): + if 'for_' in settings: + if settings.get('context') is None: + settings['context'] = settings['for_'] + self.__dict__.update(settings) + + def __call__(self, wrapped): + settings = self.__dict__.copy() + + def callback(context, name, ob): + template = os.path.join(os.path.dirname(inspect.getfile(ob)), settings.get('template')) + if not os.path.isfile(template): + raise ConfigurationError("No such file", template) + + contentType = settings.get('contentType', 'text/html') + macro = settings.get('macro') + factory = TemplateFactory(template, contentType, macro) + provides = settings.get('provides', ILayoutTemplate) + directlyProvides(factory, provides) + + config = context.config.with_package(info.module) + config.registry.registerAdapter(factory, + (ob, settings.get('layer', IRequest)), + provides, settings.get('name', '')) + + info = self.venusian.attach(wrapped, callback, category='pyams_pagelet') + + if info.scope == 'class': + # if the decorator was attached to a method in a class, or + # otherwise executed at class scope, we need to set an + # 'attr' into the settings if one isn't already in there + if settings.get('attr') is None: + settings['attr'] = wrapped.__name__ + + settings['_info'] = info.codeinfo # fbo "action_method" + return wrapped diff -r 000000000000 -r 31ded33115d7 src/pyams_template/tests/__init__.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/tests/__init__.py Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r 31ded33115d7 src/pyams_template/tests/test_utilsdocs.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/tests/test_utilsdocs.py Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,62 @@ +### -*- coding: utf-8 -*- #################################################### +############################################################################## +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# +############################################################################## + +""" +Generic Test case for pyams_template doctest +""" +__docformat__ = 'restructuredtext' + +import unittest +import doctest +import sys +import os + + +current_dir = os.path.dirname(__file__) + +def doc_suite(test_dir, setUp=None, tearDown=None, globs=None): + """Returns a test suite, based on doctests found in /doctest.""" + suite = [] + if globs is None: + globs = globals() + + flags = (doctest.ELLIPSIS | doctest.NORMALIZE_WHITESPACE | + doctest.REPORT_ONLY_FIRST_FAILURE) + + package_dir = os.path.split(test_dir)[0] + if package_dir not in sys.path: + sys.path.append(package_dir) + + doctest_dir = os.path.join(package_dir, 'doctests') + + # filtering files on extension + docs = [os.path.join(doctest_dir, doc) for doc in + os.listdir(doctest_dir) if doc.endswith('.txt')] + + for test in docs: + suite.append(doctest.DocFileSuite(test, optionflags=flags, + globs=globs, setUp=setUp, + tearDown=tearDown, + module_relative=False)) + + return unittest.TestSuite(suite) + +def test_suite(): + """returns the test suite""" + return doc_suite(current_dir) + +if __name__ == '__main__': + unittest.main(defaultTest='test_suite') + diff -r 000000000000 -r 31ded33115d7 src/pyams_template/tests/test_utilsdocstrings.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_template/tests/test_utilsdocstrings.py Thu Feb 19 10:29:02 2015 +0100 @@ -0,0 +1,65 @@ +### -*- coding: utf-8 -*- #################################################### +############################################################################## +# +# Copyright (c) 2008-2010 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# +############################################################################## + +""" +Generic Test case for pyams_template doc strings +""" +__docformat__ = 'restructuredtext' + +import unittest +import doctest +import sys +import os + + +current_dir = os.path.abspath(os.path.dirname(__file__)) + +def doc_suite(test_dir, globs=None): + """Returns a test suite, based on doc tests strings found in /*.py""" + suite = [] + if globs is None: + globs = globals() + + flags = (doctest.ELLIPSIS | doctest.NORMALIZE_WHITESPACE | + doctest.REPORT_ONLY_FIRST_FAILURE) + + package_dir = os.path.split(test_dir)[0] + if package_dir not in sys.path: + sys.path.append(package_dir) + + # filtering files on extension + docs = [doc for doc in + os.listdir(package_dir) if doc.endswith('.py')] + docs = [doc for doc in docs if not doc.startswith('__')] + + for test in docs: + fd = open(os.path.join(package_dir, test)) + content = fd.read() + fd.close() + if '>>> ' not in content: + continue + test = test.replace('.py', '') + location = 'pyams_template.%s' % test + suite.append(doctest.DocTestSuite(location, optionflags=flags, + globs=globs)) + + return unittest.TestSuite(suite) + +def test_suite(): + """returns the test suite""" + return doc_suite(current_dir) + +if __name__ == '__main__': + unittest.main(defaultTest='test_suite')