[PATCH 1 of 7 Massmailing cube] New style: conver cube to new layout

Nsukami Patrick ndkpatt at gmail.com
Wed Jun 12 18:57:46 CEST 2019


# HG changeset patch
# User Nsukami Patrick <ndkpatt at gmail dot com>
# Date 1560358150 0
#      Wed Jun 12 16:49:10 2019 +0000
# Node ID 8245f8596ab4e86058e344965a3403a6a5475ffe
# Parent  1f300771bbc21350337524fb3dd0550c17f0b3de
New style: conver cube to new layout

- move files to cube folder
- update setup.py, MANIFEST.in, __pkginfo__.py
- use unittest from std lib
- fix deprecation DeprecationWarning: [3.22] Use 'from cubicweb import _'
- fix basestring is not defined
- fix unicode is not defined
- fix SyntaxError: invalid syntax

diff --git a/MANIFEST.in b/MANIFEST.in
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,5 +1,10 @@
 include *.py
 include */*.py
-recursive-include data *.gif *.png *.ico *.css *.js
-recursive-include i18n *.po
-recursive-include wdoc *
+recursive-include cubicweb_massmailing *.py
+recursive-include cubicweb_massmailing/data *.gif *.png *.ico *.css *.js
+recursive-include cubicweb_massmailing/i18n *.po
+recursive-include cubicweb_massmailing/wdoc *
+recursive-include test/data bootstrap_cubes *.py
+include *.ini
+prune debian
+prune cubicweb-massmailing.spec
diff --git a/__init__.py b/cubicweb_massmailing/__init__.py
rename from __init__.py
rename to cubicweb_massmailing/__init__.py
diff --git a/__pkginfo__.py b/cubicweb_massmailing/__pkginfo__.py
rename from __pkginfo__.py
rename to cubicweb_massmailing/__pkginfo__.py
--- a/__pkginfo__.py
+++ b/cubicweb_massmailing/__pkginfo__.py
@@ -1,7 +1,8 @@
 # pylint: disable=W0622
 """cubicweb-massmailing application packaging information"""
 
-modname = 'massmailing'
+
+modname = 'cubicweb_massmailing'
 distname = 'cubicweb-massmailing'
 
 numversion = (0, 1, 0)
@@ -13,36 +14,13 @@
 description = 'Mass mailing handling: send mail to entities adaptable to IEmailable'
 web = 'http://www.cubicweb.org/project/%s' % distname
 
-__depends__ =  {'cubicweb': '>= 3.19.0'}
+__depends__ = {'cubicweb': '>= 3.24.0'}
 __recommends__ = {}
 
 classifiers = [
     'Environment :: Web Environment',
     'Framework :: CubicWeb',
-    'Programming Language :: Python',
+    'Programming Language :: Python :: 3',
     'Programming Language :: JavaScript',
-    ]
-
-from os import listdir as _listdir
-from os.path import join, isdir
-from glob import glob
-
-THIS_CUBE_DIR = join('share', 'cubicweb', 'cubes', modname)
+]
 
-def listdir(dirpath):
-    return [join(dirpath, fname) for fname in _listdir(dirpath)
-            if fname[0] != '.' and not fname.endswith('.pyc')
-            and not fname.endswith('~')
-            and not isdir(join(dirpath, fname))]
-
-data_files = [
-    # common files
-    [THIS_CUBE_DIR, [fname for fname in glob('*.py') if fname != 'setup.py']],
-    ]
-# check for possible extended cube layout
-for dname in ('entities', 'views', 'sobjects', 'hooks', 'schema', 'data', 'wdoc', 'i18n', 'migration'):
-    if isdir(dname):
-        data_files.append([join(THIS_CUBE_DIR, dname), listdir(dname)])
-# Note: here, you'll need to add subdirectories if you want
-# them to be included in the debian package
-
diff --git a/data/cubicweb.mailform.css b/cubicweb_massmailing/data/cubicweb.mailform.css
rename from data/cubicweb.mailform.css
rename to cubicweb_massmailing/data/cubicweb.mailform.css
diff --git a/i18n/en.po b/cubicweb_massmailing/i18n/en.po
rename from i18n/en.po
rename to cubicweb_massmailing/i18n/en.po
diff --git a/i18n/es.po b/cubicweb_massmailing/i18n/es.po
rename from i18n/es.po
rename to cubicweb_massmailing/i18n/es.po
diff --git a/i18n/fr.po b/cubicweb_massmailing/i18n/fr.po
rename from i18n/fr.po
rename to cubicweb_massmailing/i18n/fr.po
diff --git a/migration/postcreate.py b/cubicweb_massmailing/migration/postcreate.py
rename from migration/postcreate.py
rename to cubicweb_massmailing/migration/postcreate.py
diff --git a/views.py b/cubicweb_massmailing/views.py
rename from views.py
rename to cubicweb_massmailing/views.py
--- a/views.py
+++ b/cubicweb_massmailing/views.py
@@ -22,11 +22,12 @@
 """
 
 __docformat__ = "restructuredtext en"
-_ = unicode
+
 
 import operator
 import re
 from functools import reduce
+import six
 
 from cubicweb.predicates import authenticated_user, adaptable, match_form_params
 from cubicweb.view import EntityView
@@ -35,7 +36,7 @@
                           form, formfields as ff)
 from cubicweb.web.formwidgets import CheckBox, AjaxWidget, ImgButton
 from cubicweb.web.views import forms, formrenderers
-
+from cubicweb import _
 
 class SendEmailAction(action.Action):
     __regid__ = 'sendemail'
@@ -56,7 +57,7 @@
 
 
 def recipient_vocabulary(form, field):
-    vocab = [(entity.cw_adapt_to('IEmailable').get_email(), unicode(entity.eid))
+    vocab = [(entity.cw_adapt_to('IEmailable').get_email(), six.text_type(entity.eid))
              for entity in form.cw_rset.entities()]
     return [(label, value) for label, value in vocab if label]
 
@@ -167,7 +168,7 @@
         """returns an iterator on email's recipients as entities"""
         eids = self._cw.form['recipient']
         # eids may be a string if only one recipient was specified
-        if isinstance(eids, basestring):
+        if isinstance(eids, str):
             rset = self._cw.execute('Any X WHERE X eid %(x)s', {'x': eids})
         else:
             rset = self._cw.execute('Any X WHERE X eid in (%s)' % (','.join(eids)))
@@ -182,7 +183,7 @@
             iemailable = recipient.cw_adapt_to('IEmailable')
             body = text % iemailable.as_email_context()
             recipient = iemailable.get_email()
-            uinfo = re.match(ur'(?P<name>.+) <(?P<email>.+)>', sender, re.U).groupdict()
+            uinfo = re.match(r'(?P<name>.+) <(?P<email>.+)>', sender, re.U).groupdict()
             msg = format_mail(uinfo, [recipient], body, subject)
             if not req.vreg.config.sendmails([(msg, [recipient])], sender):
                 msg = req._('could not connect to the SMTP server')
diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -1,10 +1,10 @@
 #!/usr/bin/env python
 # pylint: disable=W0142,W0403,W0404,W0613,W0622,W0622,W0704,R0904,C0103,E0611
 #
-# copyright 2003-2014 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+# copyright 2003-2016 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
 # contact http://www.logilab.fr/ -- mailto:contact at logilab.fr
 #
-# This file is part of CubicWeb tag cube.
+# This file is part of a cubicweb-massmailing.
 #
 # CubicWeb is free software: you can redistribute it and/or modify it under the
 # terms of the GNU Lesser General Public License as published by the Free
@@ -16,186 +16,67 @@
 # FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 # details.
 #
-# You should have received a copy of the GNU Lesser General Public License along
-# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
-"""Generic Setup script, takes package info from __pkginfo__.py file
+# You should have received a copy of the GNU Lesser General Public License
+# along with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
+"""cubicweb_massmailing setup module using data from
+cubicweb_massmailing/__pkginfo__.py file
 """
-__docformat__ = "restructuredtext en"
-
-import os
-import sys
-import shutil
-from os.path import isdir, exists, join, walk
-
-try:
-    if os.environ.get('NO_SETUPTOOLS'):
-        raise ImportError() # do as there is no setuptools
-    from setuptools import setup
-    from setuptools.command import install_lib
-    USE_SETUPTOOLS = True
-except ImportError:
-    from distutils.core import setup
-    from distutils.command import install_lib
-    USE_SETUPTOOLS = False
-from distutils.command import install_data
 
-# import required features
-from __pkginfo__ import modname, version, license, description, web, \
-     author, author_email, classifiers
-
-if exists('README'):
-    long_description = file('README').read()
-else:
-    long_description = ''
+from os.path import join, dirname
 
-# import optional features
-import __pkginfo__
-if USE_SETUPTOOLS:
-    requires = {}
-    for entry in ("__depends__",): # "__recommends__"):
-        requires.update(getattr(__pkginfo__, entry, {}))
-    install_requires = [("%s %s" % (d, v and v or "")).strip()
-                       for d, v in requires.iteritems()]
-else:
-    install_requires = []
-
-distname = getattr(__pkginfo__, 'distname', modname)
-scripts = getattr(__pkginfo__, 'scripts', ())
-include_dirs = getattr(__pkginfo__, 'include_dirs', ())
-data_files = getattr(__pkginfo__, 'data_files', None)
-ext_modules = getattr(__pkginfo__, 'ext_modules', None)
-dependency_links = getattr(__pkginfo__, 'dependency_links', ())
-
-BASE_BLACKLIST = ('CVS', '.svn', '.hg', 'debian', 'dist', 'build')
-IGNORED_EXTENSIONS = ('.pyc', '.pyo', '.elc', '~')
+from setuptools import find_packages, setup
 
 
-def ensure_scripts(linux_scripts):
-    """
-    Creates the proper script names required for each platform
-    (taken from 4Suite)
-    """
-    from distutils import util
-    if util.get_platform()[:3] == 'win':
-        scripts_ = [script + '.bat' for script in linux_scripts]
-    else:
-        scripts_ = linux_scripts
-    return scripts_
+here = dirname(__file__)
+
+# load metadata from the __pkginfo__.py file so there is no risk of conflict
+# see https://packaging.python.org/en/latest/single_source_version.html
+pkginfo = join(here, 'cubicweb_massmailing', '__pkginfo__.py')
+__pkginfo__ = {}
+with open(pkginfo) as f:
+    exec(f.read(), __pkginfo__)
 
-def export(from_dir, to_dir,
-           blacklist=BASE_BLACKLIST,
-           ignore_ext=IGNORED_EXTENSIONS,
-           verbose=True):
-    """make a mirror of from_dir in to_dir, omitting directories and files
-    listed in the black list
-    """
-    def make_mirror(arg, directory, fnames):
-        """walk handler"""
-        for norecurs in blacklist:
-            try:
-                fnames.remove(norecurs)
-            except ValueError:
-                pass
-        for filename in fnames:
-            # don't include binary files
-            if filename[-4:] in ignore_ext:
-                continue
-            if filename[-1] == '~':
-                continue
-            src = join(directory, filename)
-            dest = to_dir + src[len(from_dir):]
-            if verbose:
-                sys.stderr.write('%s -> %s\n' % (src, dest))
-            if os.path.isdir(src):
-                if not exists(dest):
-                    os.mkdir(dest)
-            else:
-                if exists(dest):
-                    os.remove(dest)
-                shutil.copy2(src, dest)
-    try:
-        os.mkdir(to_dir)
-    except OSError as ex:
-        # file exists ?
-        import errno
-        if ex.errno != errno.EEXIST:
-            raise
-    walk(from_dir, make_mirror, None)
+# get required metadatas
+distname = __pkginfo__['distname']
+version = __pkginfo__['version']
+license = __pkginfo__['license']
+description = __pkginfo__['description']
+web = __pkginfo__['web']
+author = __pkginfo__['author']
+author_email = __pkginfo__['author_email']
+classifiers = __pkginfo__['classifiers']
+
+with open(join(here, 'README')) as f:
+    long_description = f.read()
+
+# get optional metadatas
+data_files = __pkginfo__.get('data_files', None)
+dependency_links = __pkginfo__.get('dependency_links', ())
+
+requires = {}
+for entry in ("__depends__",):  # "__recommends__"):
+    requires.update(__pkginfo__.get(entry, {}))
+install_requires = ["{0} {1}".format(d, v and v or "").strip()
+                    for d, v in requires.items()]
 
 
-class MyInstallLib(install_lib.install_lib):
-    """extend install_lib command to handle  package __init__.py and
-    include_dirs variable if necessary
-    """
-    def run(self):
-        """overridden from install_lib class"""
-        install_lib.install_lib.run(self)
-        # manually install included directories if any
-        if include_dirs:
-            base = modname
-            for directory in include_dirs:
-                dest = join(self.install_dir, base, directory)
-                export(directory, dest, verbose=False)
-
-# re-enable copying data files in sys.prefix
-old_install_data = install_data.install_data
-if USE_SETUPTOOLS:
-    # overwrite InstallData to use sys.prefix instead of the egg directory
-    class MyInstallData(old_install_data):
-        """A class that manages data files installation"""
-        def run(self):
-            _old_install_dir = self.install_dir
-            if self.install_dir.endswith('egg'):
-                self.install_dir = sys.prefix
-            old_install_data.run(self)
-            self.install_dir = _old_install_dir
-    try:
-        import setuptools.command.easy_install # only if easy_install avaible
-        # monkey patch: Crack SandboxViolation verification
-        from setuptools.sandbox import DirectorySandbox as DS
-        old_ok = DS._ok
-        def _ok(self, path):
-            """Return True if ``path`` can be written during installation."""
-            out = old_ok(self, path) # here for side effect from setuptools
-            realpath = os.path.normcase(os.path.realpath(path))
-            allowed_path = os.path.normcase(sys.prefix)
-            if realpath.startswith(allowed_path):
-                out = True
-            return out
-        DS._ok = _ok
-    except ImportError:
-        pass
-
-def install(**kwargs):
-    """setup entry point"""
-    if USE_SETUPTOOLS:
-        if '--force-manifest' in sys.argv:
-            sys.argv.remove('--force-manifest')
-    # install-layout option was introduced in 2.5.3-1~exp1
-    elif sys.version_info < (2, 5, 4) and '--install-layout=deb' in sys.argv:
-        sys.argv.remove('--install-layout=deb')
-    cmdclass = {'install_lib': MyInstallLib}
-    if USE_SETUPTOOLS:
-        kwargs['install_requires'] = install_requires
-        kwargs['dependency_links'] = dependency_links
-        kwargs['zip_safe'] = False
-        cmdclass['install_data'] = MyInstallData
-
-    return setup(name = distname,
-                 version = version,
-                 license = license,
-                 description = description,
-                 long_description = long_description,
-                 author = author,
-                 author_email = author_email,
-                 url = web,
-                 scripts = ensure_scripts(scripts),
-                 data_files = data_files,
-                 ext_modules = ext_modules,
-                 cmdclass = cmdclass,
-                 classifiers = classifiers,
-                 **kwargs
-                 )
-
-if __name__ == '__main__' :
-    install()
+setup(
+    name=distname,
+    version=version,
+    license=license,
+    description=description,
+    long_description=long_description,
+    author=author,
+    author_email=author_email,
+    url=web,
+    classifiers=classifiers,
+    packages=find_packages(exclude=['test']),
+    install_requires=install_requires,
+    include_package_data=True,
+    entry_points={
+        'cubicweb.cubes': [
+            'massmailing=cubicweb_massmailing',
+        ],
+    },
+    zip_safe=False,
+)
diff --git a/test/unittest_massmailing.py b/test/unittest_massmailing.py
--- a/test/unittest_massmailing.py
+++ b/test/unittest_massmailing.py
@@ -89,5 +89,5 @@
 
 
 if __name__ == '__main__':
-    from logilab.common.testlib import unittest_main
-    unittest_main()
+    import unittest
+    unittest.main()
diff --git a/tox.ini b/tox.ini
new file mode 100644
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,31 @@
+[tox]
+envlist = py3,flake8,check-manifest
+
+[testenv]
+deps =
+  pytest
+commands =
+  {envpython} -m pytest {posargs:test}
+
+[pytest]
+python_files = *test_*.py
+testpaths = test
+addopts = -r fEs
+
+[testenv:flake8]
+basepython = python3
+skip_install = true
+deps =
+  flake8
+commands = flake8
+
+[testenv:check-manifest]
+skip_install = true
+deps =
+  check-manifest
+commands =
+  {envpython} -m check_manifest {toxinidir}
+
+[flake8]
+max-line-length = 100
+exclude = cubicweb_massmailing/migration/*,test/data/*,.tox/*



More information about the cubicweb-devel mailing list