<commit_before># vim: tabstop=4 shiftwidth=4 softtabstop=4

# Copyright 2011 OpenStack Foundation.
# Copyright 2012-2013 Hewlett-Packard Development Company, L.P.
# All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

"""
Utilities with minimum-depends for use in setup.py
"""

import email
import os
import re
import subprocess
import sys

from setuptools.command import sdist

def parse_mailmap(mailmap='.mailmap'):
    mapping = {}
    if os.path.exists(mailmap):
        with open(mailmap, 'r') as fp:
            for l in fp:
                try:
                    canonical_email, alias = re.match(
                        r'[^#]*?(<.+>).*(<.+>).*', l).groups()
                except AttributeError:
                    continue
                mapping[alias] = canonical_email
    return mapping

def _parse_git_mailmap(git_dir, mailmap='.mailmap'):
    mailmap = os.path.join(os.path.dirname(git_dir), mailmap)
    return parse_mailmap(mailmap)

def canonicalize_emails(changelog, mapping):
    """Takes in a string and an email alias mapping and replaces all
       instances of the aliases in the string with their real email.
    """
    for alias, email_address in mapping.iteritems():
        changelog = changelog.replace(alias, email_address)
    return changelog

# Get requirements from the first file that exists
def get_reqs_from_files(requirements_files):
    for requirements_file in requirements_files:
        if os.path.exists(requirements_file):
            with open(requirements_file, 'r') as fil:
                return fil.read().split('\n')
    return []

def parse_requirements(requirements_files=['requirements.txt',
                                           'tools/pip-requires']):
    requirements = []
    for line in get_reqs_from_files(requirements_files):
        # For the requirements list, we need to inject only the portion
        # after egg= so that distutils knows the package it's looking for
        # such as:
        # -e git://github.com/openstack/nova/master#egg=nova
        if re.match(r'\s*-e\s+', line):
            requirements.append(re.sub(r'\s*-e\s+.*#egg=(.*)$', r'\1',
                                line))
        # such as:
        # http://github.com/openstack/nova/zipball/master#egg=nova
        elif re.match(r'\s*https?:', line):
            requirements.append(re.sub(r'\s*https?:.*#egg=(.*)$', r'\1',
                                line))
        # -f lines are for index locations, and don't get used here
        elif re.match(r'\s*-f\s+', line):
            pass
        # argparse is part of the standard library starting with 2.7
        # adding it to the requirements list screws distro installs
        elif line == 'argparse' and sys.version_info >= (2, 7):
            pass
        else:
            requirements.append(line)

    return requirements

def parse_dependency_links(requirements_files=['requirements.txt',
                                               'tools/pip-requires']):
    dependency_links = []
    # dependency_links inject alternate locations to find packages listed
    # in requirements
    for line in get_reqs_from_files(requirements_files):
        # skip comments and blank lines
        if re.match(r'(\s*#)|(\s*$)', line):
            continue
        # lines with -e or -f need the whole line, minus the flag
        if re.match(r'\s*-[ef]\s+', line):
            dependency_links.append(re.sub(r'\s*-[ef]\s+', '', line))
        # lines that are only urls can go in unmolested
        elif re.match(r'\s*https?:', line):
            dependency_links.append(line)
    return dependency_links

def _run_shell_command(cmd, throw_on_error=False):
    if os.name == 'nt':
        output = subprocess.Popen(["cmd.exe", "/C", cmd],
                                  stdout=subprocess.PIPE,
                                  stderr=subprocess.PIPE)
    else:
        output = subprocess.Popen(["/bin/sh", "-c", cmd],
                                  stdout=subprocess.PIPE,
                                  stderr=subprocess.PIPE)
    out = output.communicate()
    if output.returncode and throw_on_error:
        raise Exception("%s returned %d" % cmd, output.returncode)
    if len(out) == 0:
        return None
    if len(out[0].strip()) == 0:
        return None
    return out[0].strip()

def _get_git_directory():
    parent_dir = os.path.dirname(__file__)
    while True:
        git_dir = os.path.join(parent_dir, '.git')
        if os.path.exists(git_dir):
            return git_dir
        parent_dir, child = os.path.split(parent_dir)
        if not child:   # reached to root dir
            return None

def write_git_changelog():
    """Write a changelog based on the git changelog."""
    new_changelog = 'ChangeLog'
    git_dir = _get_git_directory()
    if not os.getenv('SKIP_WRITE_GIT_CHANGELOG'):
        if git_dir:
            git_log_cmd = 'git --git-dir=%s log' % git_dir
            changelog = _run_shell_command(git_log_cmd)
            mailmap = _parse_git_mailmap(git_dir)
            with open(new_changelog, "w") as changelog_file:
                changelog_file.write(canonicalize_emails(changelog, mailmap))
    else:
        open(new_changelog, 'w').close()

def generate_authors():
    """Create AUTHORS file using git commits."""
    jenkins_email = 'jenkins@review.(openstack|stackforge).org'
    old_authors = 'AUTHORS.in'
    new_authors = 'AUTHORS'
    git_dir = _get_git_directory()
    if not os.getenv('SKIP_GENERATE_AUTHORS'):
        if git_dir:
            # don't include jenkins email address in AUTHORS file
            git_log_cmd = ("git --git-dir=" + git_dir +
                           " log --format='%aN <%aE>' | sort -u | "
                           "egrep -v '" + jenkins_email + "'")
            changelog = _run_shell_command(git_log_cmd)
            signed_cmd = ("git --git-dir=" + git_dir +
                          " log | grep -i Co-authored-by: | sort -u")
            signed_entries = _run_shell_command(signed_cmd)
            if signed_entries:
                new_entries = [signed.split(":", 1)[1].strip()
                     for signed in signed_entries.split("\n") if signed]
                for new_entry in new_entries:
                    if new_entry not in changelog:
                        changelog += "\n" + new_entry
            mailmap = _parse_git_mailmap(git_dir)
            with open(new_authors, 'w') as new_authors_fh:
                new_authors_fh.write(canonicalize_emails(changelog, mailmap))
                if os.path.exists(old_authors):
                    with open(old_authors, "r") as old_authors_fh:
                        new_authors_fh.write('\n' + old_authors_fh.read())
    else:
        open(new_authors, 'w').close()

_rst_template = """%(heading)s
%(underline)s

.. automodule:: %(module)s
  :members:
  :undoc-members:
  :show-inheritance:
"""

def get_cmdclass():
    """Return dict of commands to run from setup.py."""

    cmdclass = dict()

    def _find_modules(arg, dirname, files):
        for filename in files:
            if filename.endswith('.py') and filename != '__init__.py':
                arg["%s.%s" % (dirname.replace('/', '.'),
                               filename[:-3])] = True

    class LocalSDist(sdist.sdist):
        """Builds the ChangeLog and Authors files from VC first."""

        def run(self):
            write_git_changelog()
            generate_authors()
            # sdist.sdist is an old style class, can't use super()
            sdist.sdist.run(self)

    cmdclass['sdist'] = LocalSDist

    # If Sphinx is installed on the box running setup.py,
    # enable setup.py to build the documentation, otherwise,
    # just ignore it
    try:
        from sphinx.setup_command import BuildDoc

        class LocalBuildDoc(BuildDoc):

            builders = ['html', 'man']

            def generate_autoindex(self):
                print "**Autodocumenting from %s" % os.path.abspath(os.curdir)
                modules = {}
                option_dict = self.distribution.get_option_dict('build_sphinx')
                source_dir = os.path.join(option_dict['source_dir'][1], 'api')
                if not os.path.exists(source_dir):
                    os.makedirs(source_dir)
                for pkg in self.distribution.packages:
                    if '.' not in pkg:
                        os.path.walk(pkg, _find_modules, modules)
                module_list = modules.keys()
                module_list.sort()
                autoindex_filename = os.path.join(source_dir, 'autoindex.rst')
                with open(autoindex_filename, 'w') as autoindex:
                    autoindex.write(""".. toctree::
   :maxdepth: 1

""")
                    for module in module_list:
                        output_filename = os.path.join(source_dir,
                                                       "%s.rst" % module)
                        heading = "The :mod:`%s` Module" % module
                        underline = "=" * len(heading)
                        values = dict(module=module, heading=heading,
                                      underline=underline)

                        print "Generating %s" % output_filename
                        with open(output_filename, 'w') as output_file:
                            output_file.write(_rst_template % values)
                        autoindex.write("   %s.rst\n" % module)

            def run(self):
                if not os.getenv('SPHINX_DEBUG'):
                    self.generate_autoindex()

                for builder in self.builders:
                    self.builder = builder
                    self.finalize_options()
                    self.project = self.distribution.get_name()
                    self.version = self.distribution.get_version()
                    self.release = self.distribution.get_version()
                    BuildDoc.run(self)

        class LocalBuildLatex(LocalBuildDoc):
            builders = ['latex']

        cmdclass['build_sphinx'] = LocalBuildDoc
        cmdclass['build_sphinx_latex'] = LocalBuildLatex
    except ImportError:
        pass

    return cmdclass

def _get_revno(git_dir):
    """Return the number of commits since the most recent tag.

    We use git-describe to find this out, but if there are no
    tags then we fall back to counting commits since the beginning
    of time.
    """
    describe = _run_shell_command(
        "git --git-dir=%s describe --always" % git_dir)
    if "-" in describe:
        return describe.rsplit("-", 2)[-2]

    # no tags found
    revlist = _run_shell_command(
        "git --git-dir=%s rev-list --abbrev-commit HEAD" % git_dir)
    return len(revlist.splitlines())

def _get_version_from_git(pre_version):
    """Return a version which is equal to the tag that's on the current
    revision if there is one, or tag plus number of additional revisions
    if the current revision has no tag."""

    git_dir = _get_git_directory()
    if git_dir:
        if pre_version:
            try:
                return _run_shell_command(
                    "git --git-dir=" + git_dir + " describe --exact-match",
                    throw_on_error=True).replace('-', '.')
            except Exception:
                sha = _run_shell_command(
                    "git --git-dir=" + git_dir + " log -n1 --pretty=format:%h")
                return "%s.a%s.g%s" % (pre_version, _get_revno(git_dir), sha)
        else:
            return _run_shell_command(
                "git --git-dir=" + git_dir + " describe --always").replace(
                    '-', '.')
    return None

def _get_version_from_pkg_info(package_name):
    """Get the version from PKG-INFO file if we can."""
    try:
        pkg_info_file = open('PKG-INFO', 'r')
    except (IOError, OSError):
        return None
    try:
        pkg_info = email.message_from_file(pkg_info_file)
    except email.MessageError:
        return None
    # Check to make sure we're in our own dir
    if pkg_info.get('Name', None) != package_name:
        return None
    return pkg_info.get('Version', None)

def get_version(package_name, pre_version=None):
    """Get the version of the project. First, try getting it from PKG-INFO, if
    it exists. If it does, that means we're in a distribution tarball or that
    install has happened. Otherwise, if there is no PKG-INFO file, pull the
    version from git.

    We do not support setup.py version sanity in git archive tarballs, nor do
    we support packagers directly sucking our git repo into theirs. We expect
    that a source tarball be made from our git repo - or that if someone wants
    to make a source tarball from a fork of our repo with additional tags in it
    that they understand and desire the results of doing that.
    """
    version = os.environ.get("OSLO_PACKAGE_VERSION", None)
    if version:
        return version
    version = _get_version_from_pkg_info(package_name)
    if version:
        return version
    version = _get_version_from_git(pre_version)
    if version:
        return version
    raise Exception("Versioning for this project requires either an sdist"
                    " tarball, or access to an upstream git repository.")
<commit_msg>AUTHORS file generation fixed<commit_after># vim: tabstop=4 shiftwidth=4 softtabstop=4

# Copyright 2011 OpenStack Foundation.
# Copyright 2012-2013 Hewlett-Packard Development Company, L.P.
# All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

"""
Utilities with minimum-depends for use in setup.py
"""

import email
import os
import re
import subprocess
import sys

from setuptools.command import sdist

def parse_mailmap(mailmap='.mailmap'):
    mapping = {}
    if os.path.exists(mailmap):
        with open(mailmap, 'r') as fp:
            for l in fp:
                try:
                    canonical_email, alias = re.match(
                        r'[^#]*?(<.+>).*(<.+>).*', l).groups()
                except AttributeError:
                    continue
                mapping[alias] = canonical_email
    return mapping

def _parse_git_mailmap(git_dir, mailmap='.mailmap'):
    mailmap = os.path.join(os.path.dirname(git_dir), mailmap)
    return parse_mailmap(mailmap)

def canonicalize_emails(changelog, mapping):
    """Takes in a string and an email alias mapping and replaces all
       instances of the aliases in the string with their real email.
    """
    for alias, email_address in mapping.iteritems():
        changelog = changelog.replace(alias, email_address)
    return changelog

# Get requirements from the first file that exists
def get_reqs_from_files(requirements_files):
    for requirements_file in requirements_files:
        if os.path.exists(requirements_file):
            with open(requirements_file, 'r') as fil:
                return fil.read().split('\n')
    return []

def parse_requirements(requirements_files=['requirements.txt',
                                           'tools/pip-requires']):
    requirements = []
    for line in get_reqs_from_files(requirements_files):
        # For the requirements list, we need to inject only the portion
        # after egg= so that distutils knows the package it's looking for
        # such as:
        # -e git://github.com/openstack/nova/master#egg=nova
        if re.match(r'\s*-e\s+', line):
            requirements.append(re.sub(r'\s*-e\s+.*#egg=(.*)$', r'\1',
                                line))
        # such as:
        # http://github.com/openstack/nova/zipball/master#egg=nova
        elif re.match(r'\s*https?:', line):
            requirements.append(re.sub(r'\s*https?:.*#egg=(.*)$', r'\1',
                                line))
        # -f lines are for index locations, and don't get used here
        elif re.match(r'\s*-f\s+', line):
            pass
        # argparse is part of the standard library starting with 2.7
        # adding it to the requirements list screws distro installs
        elif line == 'argparse' and sys.version_info >= (2, 7):
            pass
        else:
            requirements.append(line)

    return requirements

def parse_dependency_links(requirements_files=['requirements.txt',
                                               'tools/pip-requires']):
    dependency_links = []
    # dependency_links inject alternate locations to find packages listed
    # in requirements
    for line in get_reqs_from_files(requirements_files):
        # skip comments and blank lines
        if re.match(r'(\s*#)|(\s*$)', line):
            continue
        # lines with -e or -f need the whole line, minus the flag
        if re.match(r'\s*-[ef]\s+', line):
            dependency_links.append(re.sub(r'\s*-[ef]\s+', '', line))
        # lines that are only urls can go in unmolested
        elif re.match(r'\s*https?:', line):
            dependency_links.append(line)
    return dependency_links

def _run_shell_command(cmd, throw_on_error=False):
    if os.name == 'nt':
        output = subprocess.Popen(["cmd.exe", "/C", cmd],
                                  stdout=subprocess.PIPE,
                                  stderr=subprocess.PIPE)
    else:
        output = subprocess.Popen(["/bin/sh", "-c", cmd],
                                  stdout=subprocess.PIPE,
                                  stderr=subprocess.PIPE)
    out = output.communicate()
    if output.returncode and throw_on_error:
        raise Exception("%s returned %d" % cmd, output.returncode)
    if len(out) == 0:
        return None
    if len(out[0].strip()) == 0:
        return None
    return out[0].strip()

def _get_git_directory():
    parent_dir = os.path.dirname(__file__)
    while True:
        git_dir = os.path.join(parent_dir, '.git')
        if os.path.exists(git_dir):
            return git_dir
        parent_dir, child = os.path.split(parent_dir)
        if not child:   # reached to root dir
            return None

def write_git_changelog():
    """Write a changelog based on the git changelog."""
    new_changelog = 'ChangeLog'
    git_dir = _get_git_directory()
    if not os.getenv('SKIP_WRITE_GIT_CHANGELOG'):
        if git_dir:
            git_log_cmd = 'git --git-dir=%s log' % git_dir
            changelog = _run_shell_command(git_log_cmd)
            mailmap = _parse_git_mailmap(git_dir)
            with open(new_changelog, "w") as changelog_file:
                changelog_file.write(canonicalize_emails(changelog, mailmap))
    else:
        open(new_changelog, 'w').close()

def generate_authors():
    """Create AUTHORS file using git commits."""
    jenkins_email = 'jenkins@review.(openstack|stackforge).org'
    old_authors = 'AUTHORS.in'
    new_authors = 'AUTHORS'
    git_dir = _get_git_directory()
    if not os.getenv('SKIP_GENERATE_AUTHORS'):
        if git_dir:
            # don't include jenkins email address in AUTHORS file
            git_log_cmd = ("git --git-dir=" + git_dir +
                           " log --format='%aN <%aE>' | sort -u | "
                           "egrep -v '" + jenkins_email + "'")
            changelog = _run_shell_command(git_log_cmd)
            signed_cmd = ("git --git-dir=" + git_dir +
                          " log | grep -i Co-authored-by: | sort -u")
            signed_entries = _run_shell_command(signed_cmd)
            if signed_entries:
                new_entries = [signed.split(":", 1)[1].strip()
                     for signed in signed_entries.split("\n") if signed]
                for new_entry in new_entries:
                    if new_entry not in changelog:
                        changelog += "\n" + new_entry
            changelog += "\n"
            mailmap = _parse_git_mailmap(git_dir)
            with open(new_authors, 'w') as new_authors_fh:
                new_authors_fh.write(canonicalize_emails(changelog, mailmap))
                if os.path.exists(old_authors):
                    with open(old_authors, "r") as old_authors_fh:
                        new_authors_fh.write('\n' + old_authors_fh.read())
    else:
        open(new_authors, 'w').close()

_rst_template = """%(heading)s
%(underline)s

.. automodule:: %(module)s
  :members:
  :undoc-members:
  :show-inheritance:
"""

def get_cmdclass():
    """Return dict of commands to run from setup.py."""

    cmdclass = dict()

    def _find_modules(arg, dirname, files):
        for filename in files:
            if filename.endswith('.py') and filename != '__init__.py':
                arg["%s.%s" % (dirname.replace('/', '.'),
                               filename[:-3])] = True

    class LocalSDist(sdist.sdist):
        """Builds the ChangeLog and Authors files from VC first."""

        def run(self):
            write_git_changelog()
            generate_authors()
            # sdist.sdist is an old style class, can't use super()
            sdist.sdist.run(self)

    cmdclass['sdist'] = LocalSDist

    # If Sphinx is installed on the box running setup.py,
    # enable setup.py to build the documentation, otherwise,
    # just ignore it
    try:
        from sphinx.setup_command import BuildDoc

        class LocalBuildDoc(BuildDoc):

            builders = ['html', 'man']

            def generate_autoindex(self):
                print "**Autodocumenting from %s" % os.path.abspath(os.curdir)
                modules = {}
                option_dict = self.distribution.get_option_dict('build_sphinx')
                source_dir = os.path.join(option_dict['source_dir'][1], 'api')
                if not os.path.exists(source_dir):
                    os.makedirs(source_dir)
                for pkg in self.distribution.packages:
                    if '.' not in pkg:
                        os.path.walk(pkg, _find_modules, modules)
                module_list = modules.keys()
                module_list.sort()
                autoindex_filename = os.path.join(source_dir, 'autoindex.rst')
                with open(autoindex_filename, 'w') as autoindex:
                    autoindex.write(""".. toctree::
   :maxdepth: 1

""")
                    for module in module_list:
                        output_filename = os.path.join(source_dir,
                                                       "%s.rst" % module)
                        heading = "The :mod:`%s` Module" % module
                        underline = "=" * len(heading)
                        values = dict(module=module, heading=heading,
                                      underline=underline)

                        print "Generating %s" % output_filename
                        with open(output_filename, 'w') as output_file:
                            output_file.write(_rst_template % values)
                        autoindex.write("   %s.rst\n" % module)

            def run(self):
                if not os.getenv('SPHINX_DEBUG'):
                    self.generate_autoindex()

                for builder in self.builders:
                    self.builder = builder
                    self.finalize_options()
                    self.project = self.distribution.get_name()
                    self.version = self.distribution.get_version()
                    self.release = self.distribution.get_version()
                    BuildDoc.run(self)

        class LocalBuildLatex(LocalBuildDoc):
            builders = ['latex']

        cmdclass['build_sphinx'] = LocalBuildDoc
        cmdclass['build_sphinx_latex'] = LocalBuildLatex
    except ImportError:
        pass

    return cmdclass

def _get_revno(git_dir):
    """Return the number of commits since the most recent tag.

    We use git-describe to find this out, but if there are no
    tags then we fall back to counting commits since the beginning
    of time.
    """
    describe = _run_shell_command(
        "git --git-dir=%s describe --always" % git_dir)
    if "-" in describe:
        return describe.rsplit("-", 2)[-2]

    # no tags found
    revlist = _run_shell_command(
        "git --git-dir=%s rev-list --abbrev-commit HEAD" % git_dir)
    return len(revlist.splitlines())

def _get_version_from_git(pre_version):
    """Return a version which is equal to the tag that's on the current
    revision if there is one, or tag plus number of additional revisions
    if the current revision has no tag."""

    git_dir = _get_git_directory()
    if git_dir:
        if pre_version:
            try:
                return _run_shell_command(
                    "git --git-dir=" + git_dir + " describe --exact-match",
                    throw_on_error=True).replace('-', '.')
            except Exception:
                sha = _run_shell_command(
                    "git --git-dir=" + git_dir + " log -n1 --pretty=format:%h")
                return "%s.a%s.g%s" % (pre_version, _get_revno(git_dir), sha)
        else:
            return _run_shell_command(
                "git --git-dir=" + git_dir + " describe --always").replace(
                    '-', '.')
    return None

def _get_version_from_pkg_info(package_name):
    """Get the version from PKG-INFO file if we can."""
    try:
        pkg_info_file = open('PKG-INFO', 'r')
    except (IOError, OSError):
        return None
    try:
        pkg_info = email.message_from_file(pkg_info_file)
    except email.MessageError:
        return None
    # Check to make sure we're in our own dir
    if pkg_info.get('Name', None) != package_name:
        return None
    return pkg_info.get('Version', None)

def get_version(package_name, pre_version=None):
    """Get the version of the project. First, try getting it from PKG-INFO, if
    it exists. If it does, that means we're in a distribution tarball or that
    install has happened. Otherwise, if there is no PKG-INFO file, pull the
    version from git.

    We do not support setup.py version sanity in git archive tarballs, nor do
    we support packagers directly sucking our git repo into theirs. We expect
    that a source tarball be made from our git repo - or that if someone wants
    to make a source tarball from a fork of our repo with additional tags in it
    that they understand and desire the results of doing that.
    """
    version = os.environ.get("OSLO_PACKAGE_VERSION", None)
    if version:
        return version
    version = _get_version_from_pkg_info(package_name)
    if version:
        return version
    version = _get_version_from_git(pre_version)
    if version:
        return version
    raise Exception("Versioning for this project requires either an sdist"
                    " tarball, or access to an upstream git repository.")
<|endoftext|>


<commit_before># -*- coding: utf-8 -*-
# vim: tabstop=4 shiftwidth=4 softtabstop=4

# Copyright (c) 2010-2012, GEM Foundation.
#
# OpenQuake is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# OpenQuake is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with OpenQuake.  If not, see <http://www.gnu.org/licenses/>.

"""
Test related to code in openquake/utils/general.py
"""

import unittest

from openquake.utils import general
from openquake.utils.general import block_splitter

class SingletonTestCase(unittest.TestCase):
    """Tests the behaviour of utils.general.singleton()."""

    def test_singleton(self):
        """
        A class decorated with @singleton will always return the same
        instance upon creation.
        """

        @general.singleton
        class MySingleton(object):
            pass

        instance1 = MySingleton()
        instance2 = MySingleton()
        self.assertTrue(instance2 is instance1)
        instance3 = MySingleton()
        self.assertTrue(instance3 is instance1)

class MemoizerTestCase(unittest.TestCase):
    """Tests the behaviour of utils.general.MemoizeMutable"""

    def setUp(self):
        self.counter = 0

    def test_unashable_types(self):
        """ Tests 'unhashable' types like dict, lists """

        @general.MemoizeMutable
        def my_memoized_method(*args, **kwargs):
            """ the memoized decorated method """
            self.counter += 1
            return self.counter

        # not cached
        my_memoized_method([1, 2, 3],
                           {'key1': 'value1', 'key2': 'value2'})

        # cached with return values
        self.assertEqual(1, my_memoized_method([1, 2, 3],
                           {'key1': 'value1', 'key2': 'value2'}))

        # should be called only one time
        self.assertEqual(self.counter, 1)

    def test_memoizer(self):
        """ Tests the caching of 'normal' types """

        @general.MemoizeMutable
        def my_memoized_method(mystring, myint):
            """ the memoized decorated method """
            self.counter += 1
            return self.counter

        # not cached
        my_memoized_method('bla', 1)

        # cached with return values
        self.assertEqual(1, my_memoized_method('bla', 1))

        # should be called only one time
        self.assertEqual(self.counter, 1)

class BlockSplitterTestCase(unittest.TestCase):
    """Tests for :function:`openquake.utils.general.block_splitter`."""

    DATA = range(10)

    def test_block_splitter(self):
        expected = [
            [0, 1, 2],
            [3, 4, 5],
            [6, 7, 8],
            [9],
        ]
        actual = [x for x in block_splitter(self.DATA, 3)]
        self.assertEqual(expected, actual)

    def test_block_splitter_block_size_eq_data_len(self):
        expected = [self.DATA]
        actual = [x for x in block_splitter(self.DATA, 10)]
        self.assertEqual(expected, actual)

    def test_block_splitter_block_size_gt_data_len(self):
        expected = [self.DATA]
        actual = [x for x in block_splitter(self.DATA, 11)]
        self.assertEqual(expected, actual)

    def test_block_splitter_zero_block_size(self):
        gen = block_splitter(self.DATA, 0)
        self.assertRaises(ValueError, gen.next)

    def test_block_splitter_block_size_lt_zero(self):
        gen = block_splitter(self.DATA, -1)
        self.assertRaises(ValueError, gen.next)

    def test_block_splitter_with_generator(self):
        # Test the block with a data set of unknown length
        # (such as a generator)
        data = xrange(10)
        expected = [
            [0, 1, 2],
            [3, 4, 5],
            [6, 7, 8],
            [9],
        ]
        actual = [x for x in block_splitter(data, 3)]
        self.assertEqual(expected, actual)

    def test_block_splitter_with_iter(self):
        # Test the block with a data set of unknown length
        # (such as a generator)
        data = iter(range(10))
        expected = [
            [0, 1, 2],
            [3, 4, 5],
            [6, 7, 8],
            [9],
        ]
        actual = [x for x in block_splitter(data, 3)]
        self.assertEqual(expected, actual)
<commit_msg>tests/utils_general_test:<commit_after># -*- coding: utf-8 -*-
# vim: tabstop=4 shiftwidth=4 softtabstop=4

# Copyright (c) 2010-2012, GEM Foundation.
#
# OpenQuake is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# OpenQuake is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with OpenQuake.  If not, see <http://www.gnu.org/licenses/>.

"""
Test related to code in openquake/utils/general.py
"""

import unittest

from openquake.utils import general
from openquake.utils.general import block_splitter

class SingletonTestCase(unittest.TestCase):
    """Tests the behaviour of utils.general.singleton()."""

    def test_singleton(self):
        """
        A class decorated with @singleton will always return the same
        instance upon creation.
        """

        @general.singleton
        class MySingleton(object):
            pass

        instance1 = MySingleton()
        instance2 = MySingleton()
        self.assertTrue(instance2 is instance1)
        instance3 = MySingleton()
        self.assertTrue(instance3 is instance1)

class MemoizerTestCase(unittest.TestCase):
    """Tests the behaviour of utils.general.MemoizeMutable"""

    def setUp(self):
        self.counter = 0

    def test_unashable_types(self):
        """ Tests 'unhashable' types like dict, lists """

        @general.MemoizeMutable
        def my_memoized_method(*args, **kwargs):
            """ the memoized decorated method """
            self.counter += 1
            return self.counter

        # not cached
        my_memoized_method([1, 2, 3],
                           {'key1': 'value1', 'key2': 'value2'})

        # cached with return values
        self.assertEqual(1, my_memoized_method([1, 2, 3],
                           {'key1': 'value1', 'key2': 'value2'}))

        # should be called only one time
        self.assertEqual(self.counter, 1)

    def test_memoizer(self):
        """ Tests the caching of 'normal' types """

        @general.MemoizeMutable
        def my_memoized_method(mystring, myint):
            """ the memoized decorated method """
            self.counter += 1
            return self.counter

        # not cached
        my_memoized_method('bla', 1)

        # cached with return values
        self.assertEqual(1, my_memoized_method('bla', 1))

        # should be called only one time
        self.assertEqual(self.counter, 1)

class BlockSplitterTestCase(unittest.TestCase):
    """Tests for :function:`openquake.utils.general.block_splitter`."""

    DATA = range(10)

    def test_block_splitter(self):
        expected = [
            [0, 1, 2],
            [3, 4, 5],
            [6, 7, 8],
            [9],
        ]
        actual = [x for x in block_splitter(self.DATA, 3)]
        self.assertEqual(expected, actual)

    def test_block_splitter_block_size_eq_data_len(self):
        expected = [self.DATA]
        actual = [x for x in block_splitter(self.DATA, 10)]
        self.assertEqual(expected, actual)

    def test_block_splitter_block_size_gt_data_len(self):
        expected = [self.DATA]
        actual = [x for x in block_splitter(self.DATA, 11)]
        self.assertEqual(expected, actual)

    def test_block_splitter_zero_block_size(self):
        gen = block_splitter(self.DATA, 0)
        self.assertRaises(ValueError, gen.next)

    def test_block_splitter_block_size_lt_zero(self):
        gen = block_splitter(self.DATA, -1)
        self.assertRaises(ValueError, gen.next)

    def test_block_splitter_with_generator(self):
        # Test the block with a data set of unknown length
        # (such as a generator)
        data = xrange(10)
        expected = [
            [0, 1, 2],
            [3, 4, 5],
            [6, 7, 8],
            [9],
        ]
        actual = [x for x in block_splitter(data, 3)]
        self.assertEqual(expected, actual)

    def test_block_splitter_with_iter(self):
        # Test the block with a data set of unknown length
        data = iter(range(10))
        expected = [
            [0, 1, 2],
            [3, 4, 5],
            [6, 7, 8],
            [9],
        ]
        actual = [x for x in block_splitter(data, 3)]
        self.assertEqual(expected, actual)
<|endoftext|>


<commit_before>"""Controls activity related to RGB color sensor."""
import time

import pybbb.bbb.pwm as pwm_mod
from i2c_device.i2c_device import I2CDevice
import lib.lib as lib

class ColorSensor(I2CDevice):

    """Wrapper class for TCS3472 I2C-based color sensor."""

    # TODO: Make these config items and load in __init__()
    max_c = 65536

    #Base values to be changed by get_baseline
    bv = 0.0
    bc = 0.0
    bg = 0.0
    br = 0.0
    bb = 0.0

    def __init__(self):
        """Initialized I2C device, LED brightness PWM pin."""
        self.logger = lib.get_logger()
        self.bot_config = lib.get_config()

        # Handle off-bone runs
        self.testing = self.bot_config["testing"]
        if not self.testing:
            self.logger.debug("Running in non-test mode")

            # Setup I2C
            I2CDevice.__init__(self, 1, 0x29, config='tcs3472_i2c.yaml')
            enable = self.registers['ENABLE']
            id = self.registers['ID']
            status = self.registers['STATUS']
            enable.write('PON', 'Enable')
            enable.write('AEN', 'Enable')
            enable = self.registers['ENABLE']  # TODO: Is this needed?

            # Setup PWM pin for dimming LED
            self.pwm_num = self.bot_config["color_sensor"]["LED_PWM"]
            self.pwm = pwm_mod.PWM(self.pwm_num)
            # Duty cycle = 50% (from 20msec)
            self.pwm.duty = 1000000
        else:
            self.logger.debug("Running in test mode")

        # Gets base values for comparisons to future readings.
        self.get_baseline()

    @property
    def color(self):
        """Actual color currently being viewed.

        :returns: dict containing color components.

        """
        v, c, r, g, b = self.read_data()
        color = {"clear": c,
                  "red": r,
                  "green": g,
                  "blue": b}
        return color

    def get_data_normalized(self):
        """Finds normalized color readings, compared to overall color viewing.

        :returns: Validity, Clear (magnitude), red, green, blue

        """
        valid, c, r, g, b = self.read_data()
        # NOTE: It appears that c = r + g + b
        # so 1/c is a good normalizing factor.
        # This ensures that normalized values indicate relative proportions.
        # We could also normalize each by a constant,
        # say, the max value (65535).
        c = float(c)

        r /= c
        g /= c
        b /= c
        c /= self.max_c  # normalize c to [0, 1] range
        return valid, c, r, g, b  # return valid flag if someone's interested

    def read_data(self):
        """Reads in raw data directly from color_sensor.

        :returns: Validity, Clear (magnitude), Red, Green, Blue.

        """
        if not self.testing:
            valid = self.registers['STATUS'].read('AVALID')
            c = self.registers['CDATA'].read()
            r = self.registers['RDATA'].read()
            g = self.registers['GDATA'].read()
            b = self.registers['BDATA'].read()
            return valid, c, r, g, b
        else:
            return 1, 1, 1, 1, 1

    def get_percentage(self):
        """Calculates percentages of total color for each color.

        :returns: Validity, Clear (magnitude), Red, Green, Blue.

        """
        v, c, r, g, b = self.get_data_normalized()
        total = r + g + b
        r = (r / total) * 100
        g = (g / total) * 100
        b = (b / total) * 100
        return v, c, r, g, b

    def get_baseline(self):
        """Obtains "base" colors to work from.

        :raises AssertionError: When Color sensor saw nothing.

        """
        self.bv, self.bc, \
        self.br, self.bg, \
        self.bb = self.read_data()
        try:
            assert (self.bc != 0 and self.br != 0 and self.bg != 0 and self.bb != 0)
        except AssertionError:
            raise AssertionError("Baselines colors are zero.")

    def get_percent_diff(self):
        """Calculates percent difference from baseline.

        :returns: percent differences of brightness, and colors.

        """
        diff_c = (self.color["clear"] - self.bc) / self.bc
        diff_r = (self.color["red"] - self.br) / self.br
        diff_g = (self.color["green"] - self.bg) / self.bg
        diff_b = (self.color["blue"] - self.bb) / self.bb
        return diff_c, diff_r, diff_g, diff_b

    @lib.api_call
    def detects_color(self, color):
        """Checks to see if given color is present.

        :param color: Color to check for.
        :type color: string

        :returns: True if color found. False otherwise.

        """
        diff_c, diff_r, diff_g, diff_b = self.get_percent_diff()

        if color == "green":
            if (diff_g > diff_r) and (diff_g > diff_b):
                return True
        elif color == "red":
            if (diff_r > diff_g) and (diff_r > diff_b):
                return True
        elif color == "blue":
            if (diff_b > diff_g) and (diff_b > diff_r):
                return True
        else:
            return "Error: Unknown color"

        return False

    @lib.api_call
    def watch_for_color(self, color, timeout=60):
        """Waits for given color to be found.

        :param color: Color to wait for.
        :type color: string
        :param timeout: Maximum time in seconds for which it will wait.
        :type timeout: float
        :returns: True when color is eventually found. False if never found.
        """
        start_time = time.time()

        while time.time() - start_time < timeout:
            if self.detects_color(color):
                return True
        return False

    def detects_color_diff_method(self, color, thresh=0.2):
        """Finds color based on the total % of total color that is seen.

        Each percentage is a fraction of the total color (r+g+b)
        as seen by the color sensor. The percentages all add up
        to 100.

        Note: This is experimental and not recommended for use.

        :param color: Color to search for.
        :type color: string
        :param thresh: Difference in percentage expected.
        :type thresh: float
        :returns: True if color is found. False otherwise.

        """
        # Reads in percentages of total color
        pv, pc, \
        percent_red,\
        percent_green, \
        percent_blue = self.get_percentage()

        total_color = self.color["red"] \
                    + self.color["green"] \
                    + self.color["blue"]

        total_base = self.br + self.bg + self.bb

        # Base percentages for each color
        percent_baser = self.br / total_base * 100
        percent_baseg = self.bg / total_base * 100
        percent_baseb = self.bb / total_base * 100

        # returns True when the percentage of a color goes up by thresh
        if color == "green":
            if percent_green - percent_baseg > thresh:
                return True
        elif color == "red":
            if percent_red - percent_baser > thresh:
                return True
        elif color == "blue":
            if percent_blue - percent_baseb > thresh:
                return True
        else:
            return "Error: Unknown color"
        return False

def read_loop():
    """Instantiate a ColorSensor object and read indefinitely."""
    print "start"
    colorSensor = ColorSensor()

    #gets base values for all colors.
    time.sleep(0.5)
    colorSensor.get_baseline()

    print "bv: {}, bc: {:5.3f}, br: {:5.3f}, bg: {:5.3f}, bb: {:5.3f}".format(colorSensor.bv, \
                                                                            colorSensor.bc,\
                                                                            colorSensor.br,\
                                                                            colorSensor.bg,\
                                                                            colorSensor.bb)

    # self.logger.debug("baseline: bv: {}, bc: {}, br: {}, bg: {}, bb: {}".format(bv, bc, br, bg, bb))

    print "before loop"
    t0 = time.time()
    while True:
        try:
            elapsed = time.time() - t0
            # print "[{:8.3f}] ".format(elapsed)
            # print "v: {}, c: {:5.3f}, r: {:5.3f}, g: {:5.3f}, b: {:5.3f}".format(v, c, r, g, b)

            # if colorSensor.is_green():
                # print "Found green"
            if colorSensor.detects_color("green"):
                print "Found green, Percent method"

            # if colorSensor.is_green_diff_method():
                # print "diff method"

            #print "v: {}  c: {}, r: {}, g: {} b: {}".format(valid, c, r, g, b)
            # v, c, r, g, b = colorSensor.get_data_normalized()  # read normalized RGB values
            #v, c, r, g, b = colorSensor.get_percentage()
            # Find out which color has plurality of percentage.
            # print "v: {}, c: {:5.3f}, r: {:5.3f}, g: {:5.3f}, b: {:5.3f}".format(v, c, r, g, b)

            time.sleep(0.1)
        except KeyboardInterrupt:
            break
    print "Done."

if __name__ == "__main__":
    read_loop()
<commit_msg>Shorter timeout in color sensor<commit_after>"""Controls activity related to RGB color sensor."""
import time

import pybbb.bbb.pwm as pwm_mod
from i2c_device.i2c_device import I2CDevice
import lib.lib as lib

class ColorSensor(I2CDevice):

    """Wrapper class for TCS3472 I2C-based color sensor."""

    # TODO: Make these config items and load in __init__()
    max_c = 65536

    #Base values to be changed by get_baseline
    bv = 0.0
    bc = 0.0
    bg = 0.0
    br = 0.0
    bb = 0.0

    def __init__(self):
        """Initialized I2C device, LED brightness PWM pin."""
        self.logger = lib.get_logger()
        self.bot_config = lib.get_config()

        # Handle off-bone runs
        self.testing = self.bot_config["testing"]
        if not self.testing:
            self.logger.debug("Running in non-test mode")

            # Setup I2C
            I2CDevice.__init__(self, 1, 0x29, config='tcs3472_i2c.yaml')
            enable = self.registers['ENABLE']
            id = self.registers['ID']
            status = self.registers['STATUS']
            enable.write('PON', 'Enable')
            enable.write('AEN', 'Enable')
            enable = self.registers['ENABLE']  # TODO: Is this needed?

            # Setup PWM pin for dimming LED
            self.pwm_num = self.bot_config["color_sensor"]["LED_PWM"]
            self.pwm = pwm_mod.PWM(self.pwm_num)
            # Duty cycle = 50% (from 20msec)
            self.pwm.duty = 1000000
        else:
            self.logger.debug("Running in test mode")

        # Gets base values for comparisons to future readings.
        self.get_baseline()

    @property
    def color(self):
        """Actual color currently being viewed.

        :returns: dict containing color components.

        """
        v, c, r, g, b = self.read_data()
        color = {"clear": c,
                  "red": r,
                  "green": g,
                  "blue": b}
        return color

    def get_data_normalized(self):
        """Finds normalized color readings, compared to overall color viewing.

        :returns: Validity, Clear (magnitude), red, green, blue

        """
        valid, c, r, g, b = self.read_data()
        # NOTE: It appears that c = r + g + b
        # so 1/c is a good normalizing factor.
        # This ensures that normalized values indicate relative proportions.
        # We could also normalize each by a constant,
        # say, the max value (65535).
        c = float(c)

        r /= c
        g /= c
        b /= c
        c /= self.max_c  # normalize c to [0, 1] range
        return valid, c, r, g, b  # return valid flag if someone's interested

    def read_data(self):
        """Reads in raw data directly from color_sensor.

        :returns: Validity, Clear (magnitude), Red, Green, Blue.

        """
        if not self.testing:
            valid = self.registers['STATUS'].read('AVALID')
            c = self.registers['CDATA'].read()
            r = self.registers['RDATA'].read()
            g = self.registers['GDATA'].read()
            b = self.registers['BDATA'].read()
            return valid, c, r, g, b
        else:
            return 1, 1, 1, 1, 1

    def get_percentage(self):
        """Calculates percentages of total color for each color.

        :returns: Validity, Clear (magnitude), Red, Green, Blue.

        """
        v, c, r, g, b = self.get_data_normalized()
        total = r + g + b
        r = (r / total) * 100
        g = (g / total) * 100
        b = (b / total) * 100
        return v, c, r, g, b

    def get_baseline(self):
        """Obtains "base" colors to work from.

        :raises AssertionError: When Color sensor saw nothing.

        """
        self.bv, self.bc, \
        self.br, self.bg, \
        self.bb = self.read_data()
        try:
            assert (self.bc != 0 and self.br != 0 and self.bg != 0 and self.bb != 0)
        except AssertionError:
            raise AssertionError("Baselines colors are zero.")

    def get_percent_diff(self):
        """Calculates percent difference from baseline.

        :returns: percent differences of brightness, and colors.

        """
        diff_c = (self.color["clear"] - self.bc) / self.bc
        diff_r = (self.color["red"] - self.br) / self.br
        diff_g = (self.color["green"] - self.bg) / self.bg
        diff_b = (self.color["blue"] - self.bb) / self.bb
        return diff_c, diff_r, diff_g, diff_b

    @lib.api_call
    def detects_color(self, color):
        """Checks to see if given color is present.

        :param color: Color to check for.
        :type color: string

        :returns: True if color found. False otherwise.

        """
        diff_c, diff_r, diff_g, diff_b = self.get_percent_diff()

        if color == "green":
            if (diff_g > diff_r) and (diff_g > diff_b):
                return True
        elif color == "red":
            if (diff_r > diff_g) and (diff_r > diff_b):
                return True
        elif color == "blue":
            if (diff_b > diff_g) and (diff_b > diff_r):
                return True
        else:
            return "Error: Unknown color"

        return False

    @lib.api_call
    def watch_for_color(self, color, timeout=5):
        """Waits for given color to be found.

        :param color: Color to wait for.
        :type color: string
        :param timeout: Maximum time in seconds for which it will wait.
        :type timeout: float
        :returns: True when color is eventually found. False if never found.
        """
        start_time = time.time()

        while time.time() - start_time < timeout:
            if self.detects_color(color):
                return True
        return False

    def detects_color_diff_method(self, color, thresh=0.2):
        """Finds color based on the total % of total color that is seen.

        Each percentage is a fraction of the total color (r+g+b)
        as seen by the color sensor. The percentages all add up
        to 100.

        Note: This is experimental and not recommended for use.

        :param color: Color to search for.
        :type color: string
        :param thresh: Difference in percentage expected.
        :type thresh: float
        :returns: True if color is found. False otherwise.

        """
        # Reads in percentages of total color
        pv, pc, \
        percent_red,\
        percent_green, \
        percent_blue = self.get_percentage()

        total_color = self.color["red"] \
                    + self.color["green"] \
                    + self.color["blue"]

        total_base = self.br + self.bg + self.bb

        # Base percentages for each color
        percent_baser = self.br / total_base * 100
        percent_baseg = self.bg / total_base * 100
        percent_baseb = self.bb / total_base * 100

        # returns True when the percentage of a color goes up by thresh
        if color == "green":
            if percent_green - percent_baseg > thresh:
                return True
        elif color == "red":
            if percent_red - percent_baser > thresh:
                return True
        elif color == "blue":
            if percent_blue - percent_baseb > thresh:
                return True
        else:
            return "Error: Unknown color"
        return False

def read_loop():
    """Instantiate a ColorSensor object and read indefinitely."""
    print "start"
    colorSensor = ColorSensor()

    #gets base values for all colors.
    time.sleep(0.5)
    colorSensor.get_baseline()

    print "bv: {}, bc: {:5.3f}, br: {:5.3f}, bg: {:5.3f}, bb: {:5.3f}".format(colorSensor.bv, \
                                                                            colorSensor.bc,\
                                                                            colorSensor.br,\
                                                                            colorSensor.bg,\
                                                                            colorSensor.bb)

    # self.logger.debug("baseline: bv: {}, bc: {}, br: {}, bg: {}, bb: {}".format(bv, bc, br, bg, bb))

    print "before loop"
    t0 = time.time()
    while True:
        try:
            elapsed = time.time() - t0
            # print "[{:8.3f}] ".format(elapsed)
            # print "v: {}, c: {:5.3f}, r: {:5.3f}, g: {:5.3f}, b: {:5.3f}".format(v, c, r, g, b)

            # if colorSensor.is_green():
                # print "Found green"
            if colorSensor.detects_color("green"):
                print "Found green, Percent method"

            # if colorSensor.is_green_diff_method():
                # print "diff method"

            #print "v: {}  c: {}, r: {}, g: {} b: {}".format(valid, c, r, g, b)
            # v, c, r, g, b = colorSensor.get_data_normalized()  # read normalized RGB values
            #v, c, r, g, b = colorSensor.get_percentage()
            # Find out which color has plurality of percentage.
            # print "v: {}, c: {:5.3f}, r: {:5.3f}, g: {:5.3f}, b: {:5.3f}".format(v, c, r, g, b)

            time.sleep(0.1)
        except KeyboardInterrupt:
            break
    print "Done."

if __name__ == "__main__":
    read_loop()
<|endoftext|>


<commit_before>"""Controls activity related to RGB color sensor."""
import time

import pybbb.bbb.pwm as pwm_mod
from i2c_device.i2c_device import I2CDevice
import lib.lib as lib

class ColorSensor(I2CDevice):

    """Wrapper class for TCS3472 I2C-based color sensor."""

    # TODO: Make these config items and load in __init__()
    max_c = 65536

    #Base values to be changed by get_baseline
    bv = 0.0
    bc = 0.0
    bg = 0.0
    br = 0.0
    bb = 0.0

    def __init__(self):
        """Initialized I2C device, LED brightness PWM pin."""
        self.logger = lib.get_logger()
        self.bot_config = lib.get_config()

        # Handle off-bone runs
        self.testing = self.bot_config["testing"]
        if not self.testing:
            self.logger.debug("Running in non-test mode")

            # Setup I2C
            I2CDevice.__init__(self, 1, 0x29, config='tcs3472_i2c.yaml')
            enable = self.registers['ENABLE']
            id = self.registers['ID']
            status = self.registers['STATUS']
            enable.write('PON', 'Enable')
            enable.write('AEN', 'Enable')
            enable = self.registers['ENABLE']  # TODO: Is this needed?

            # Setup PWM pin for dimming LED
            self.pwm_num = self.bot_config["color_sensor"]["LED_PWM"]
            self.pwm = pwm_mod.PWM(self.pwm_num)
            # Duty cycle = 50% (from 20msec)
            self.pwm.duty = 1000000
        else:
            self.logger.debug("Running in test mode")

        # Gets base values for comparisons to future readings.
        self.get_baseline()

    @property
    def color(self):
        """Actual color currently being viewed.

        :returns: dict containing color components.

        """
        v, c, r, g, b = self.read_data()
        color = {"clear": c,
                  "red": r,
                  "green": g,
                  "blue": b}
        return color

    def get_data_normalized(self):
        """Finds normalized color readings, compared to overall color viewing.

        :returns: Validity, Clear (magnitude), red, green, blue

        """
        valid, c, r, g, b = self.read_data()
        # NOTE: It appears that c = r + g + b
        # so 1/c is a good normalizing factor.
        # This ensures that normalized values indicate relative proportions.
        # We could also normalize each by a constant,
        # say, the max value (65535).
        c = float(c)

        r /= c
        g /= c
        b /= c
        c /= self.max_c  # normalize c to [0, 1] range
        return valid, c, r, g, b  # return valid flag if someone's interested

    @lib.api_call
    def LED_brightness(self,brightness):
        """Changes brightness of LED.
        :param brightness:
        :type int: Percent of fully on LED brightness.

        """

        # try:
            # assert duty_period < 2*10^6
        # except AssertionError:
            # raise AssertionError("invalid duty cycle")

        self.pwm.duty = int(brightness/100. * 2000000)

    def read_data(self, bias_color="", bias_constant=0):
        """Reads in raw data directly from color_sensor.

        :param bias_color: One color can be made more sensitive.
            note: May cause false positives.
            recommended values are ~1%
        :param bias_constant: Percentage increase by which to bias.
        :returns: Validity, Clear (magnitude), Red, Green, Blue.

        """
        if not self.testing:
            valid = self.registers['STATUS'].read('AVALID')
            c = self.registers['CDATA'].read()
            r = self.registers['RDATA'].read()
            g = self.registers['GDATA'].read()
            b = self.registers['BDATA'].read()

            if bias_color == "green":
                g *= 1 + bias_constant/100
            elif bias_color == "red":
                r *= 1 + bias_constant/100
            elif bias_color == "blue":
                b *= 1 + bias_constant/100

            return valid, c, r, g, b
        else:
            return 1, 1, 1, 1, 1

    def get_percentage(self):
        """Calculates percentages of total color for each color.

        :returns: Validity, Clear (magnitude), Red, Green, Blue.

        """
        v, c, r, g, b = self.get_data_normalized()
        total = r + g + b
        r = (r / total) * 100
        g = (g / total) * 100
        b = (b / total) * 100
        return v, c, r, g, b

    def get_baseline(self):
        """Obtains "base" colors to work from.

        :raises AssertionError: When Color sensor saw nothing.

        """

        # Repeatedly attempts baseline if zeros are found.
        # Note: if this doesn't work on the first try, something
        # is usually wrong.
        while True:
            self.bv, self.bc, \
            self.br, self.bg, \
            self.bb = self.read_data()
            if self.br != 0 and self.bg != 0 and self.bb != 0:
                break
            self.logger.error("Baseline not found on first attempt.")

    def get_percent_diff(self):
        """Calculates percent difference from baseline.

        :returns: percent differences of brightness, and colors.

        """
        diff_c = (self.color["clear"] - self.bc) / self.bc
        diff_r = (self.color["red"] - self.br) / self.br
        diff_g = (self.color["green"] - self.bg) / self.bg
        diff_b = (self.color["blue"] - self.bb) / self.bb

        diff_g *= 1.01

        return diff_c, diff_r, diff_g, diff_b

    @lib.api_call
    def detects_color(self, color):
        """Checks to see if given color is present.

        :param color: Color to check for.
        :type color: string

        :returns: True if color found. False otherwise.

        """
        diff_c, diff_r, diff_g, diff_b = self.get_percent_diff()

        if color == "green":
            if (diff_g > diff_r) and (diff_g  > diff_b):
                return True
        elif color == "red":
            if (diff_r > diff_g) and (diff_r > diff_b):
                return True
        elif color == "blue":
            if (diff_b > diff_g) and (diff_b > diff_r):
                return True
        else:
            return "Error: Unknown color"

        return False

    @lib.api_call
    def watch_for_color(self, color, timeout=5):
        """Waits for given color to be found.

        :param color: Color to wait for.
        :type color: string
        :param timeout: Maximum time in seconds for which it will wait.
        :type timeout: float
        :returns: True when color is eventually found. False if never found.
        """
        start_time = time.time()

        while time.time() - start_time < timeout:
            if self.detects_color(color):
                return True
        return False

    def detects_color_diff_method(self, color, thresh=0.2):
        """Finds color based on the total % of total color that is seen.

        Each percentage is a fraction of the total color (r+g+b)
        as seen by the color sensor. The percentages all add up
        to 100.

        Note: This is experimental and not recommended for use.

        :param color: Color to search for.
        :type color: string
        :param thresh: Difference in percentage expected.
        :type thresh: float
        :returns: True if color is found. False otherwise.

        """
        # Reads in percentages of total color
        pv, pc, \
        percent_red,\
        percent_green, \
        percent_blue = self.get_percentage()

        total_color = self.color["red"] \
                    + self.color["green"] \
                    + self.color["blue"]

        total_base = self.br + self.bg + self.bb

        # Base percentages for each color
        percent_baser = self.br / total_base * 100
        percent_baseg = self.bg / total_base * 100
        percent_baseb = self.bb / total_base * 100

        # returns True when the percentage of a color goes up by thresh
        if color == "green":
            if percent_green - percent_baseg > thresh:
                return True
        elif color == "red":
            if percent_red - percent_baser > thresh:
                return True
        elif color == "blue":
            if percent_blue - percent_baseb > thresh:
                return True
        else:
            return "Error: Unknown color"
        return False

def read_loop():
    """Instantiate a ColorSensor object and read indefinitely."""
    print "start"
    colorSensor = ColorSensor()

    #gets base values for all colors.
    time.sleep(0.5)
    colorSensor.get_baseline()

    print "bv: {}, bc: {:5.3f}, br: {:5.3f}, bg: {:5.3f}, bb: {:5.3f}".format(colorSensor.bv, \
                                                                            colorSensor.bc,\
                                                                            colorSensor.br,\
                                                                            colorSensor.bg,\
                                                                            colorSensor.bb)

    # self.logger.debug("baseline: bv: {}, bc: {}, br: {}, bg: {}, bb: {}".format(bv, bc, br, bg, bb))

    print "before loop"
    t0 = time.time()
    while True:
        try:
            elapsed = time.time() - t0
            print "[{:8.3f}] ".format(elapsed)
            print "bv: {}, bc: {:5.3f}, br: {:5.3f}, bg: {:5.3f}, bb: {:5.3f}".format(colorSensor.bv, \
                                                                            colorSensor.color["clear"],\
                                                                            colorSensor.color["red"],\
                                                                            colorSensor.color["green"],\
                                                                            colorSensor.color["blue"])
            # if colorSensor.detects_color("green"):
                # print "Found green, Percent method"

            # if colorSensor.is_green_diff_method():
                # print "diff method"

            #print "v: {}  c: {}, r: {}, g: {} b: {}".format(valid, c, r, g, b)
            # v, c, r, g, b = colorSensor.get_data_normalized()  # read normalized RGB values
            #v, c, r, g, b = colorSensor.get_percentage()
            # Find out which color has plurality of percentage.
            # print "v: {}, c: {:5.3f}, r: {:5.3f}, g: {:5.3f}, b: {:5.3f}".format(v, c, r, g, b)

            time.sleep(0.1)
        except KeyboardInterrupt:
            break
    print "Done."

if __name__ == "__main__":
    read_loop()
<commit_msg>changed LED_brightness() to led_brightness()<commit_after>"""Controls activity related to RGB color sensor."""
import time

import pybbb.bbb.pwm as pwm_mod
from i2c_device.i2c_device import I2CDevice
import lib.lib as lib

class ColorSensor(I2CDevice):

    """Wrapper class for TCS3472 I2C-based color sensor."""

    # TODO: Make these config items and load in __init__()
    max_c = 65536

    #Base values to be changed by get_baseline
    bv = 0.0
    bc = 0.0
    bg = 0.0
    br = 0.0
    bb = 0.0

    def __init__(self):
        """Initialized I2C device, LED brightness PWM pin."""
        self.logger = lib.get_logger()
        self.bot_config = lib.get_config()

        # Handle off-bone runs
        self.testing = self.bot_config["testing"]
        if not self.testing:
            self.logger.debug("Running in non-test mode")

            # Setup I2C
            I2CDevice.__init__(self, 1, 0x29, config='tcs3472_i2c.yaml')
            enable = self.registers['ENABLE']
            id = self.registers['ID']
            status = self.registers['STATUS']
            enable.write('PON', 'Enable')
            enable.write('AEN', 'Enable')
            enable = self.registers['ENABLE']  # TODO: Is this needed?

            # Setup PWM pin for dimming LED
            self.pwm_num = self.bot_config["color_sensor"]["LED_PWM"]
            self.pwm = pwm_mod.PWM(self.pwm_num)
            # Duty cycle = 50% (from 20msec)
            self.pwm.duty = 1000000
        else:
            self.logger.debug("Running in test mode")

        # Gets base values for comparisons to future readings.
        self.get_baseline()

    @property
    def color(self):
        """Actual color currently being viewed.

        :returns: dict containing color components.

        """
        v, c, r, g, b = self.read_data()
        color = {"clear": c,
                  "red": r,
                  "green": g,
                  "blue": b}
        return color

    def get_data_normalized(self):
        """Finds normalized color readings, compared to overall color viewing.

        :returns: Validity, Clear (magnitude), red, green, blue

        """
        valid, c, r, g, b = self.read_data()
        # NOTE: It appears that c = r + g + b
        # so 1/c is a good normalizing factor.
        # This ensures that normalized values indicate relative proportions.
        # We could also normalize each by a constant,
        # say, the max value (65535).
        c = float(c)

        r /= c
        g /= c
        b /= c
        c /= self.max_c  # normalize c to [0, 1] range
        return valid, c, r, g, b  # return valid flag if someone's interested

    @lib.api_call
    def led_brightness(self,brightness):
        """Changes brightness of LED.
        :param brightness:
        :type int: Percent of fully on LED brightness.

        """

        # try:
            # assert duty_period < 2*10^6
        # except AssertionError:
            # raise AssertionError("invalid duty cycle")

        self.pwm.duty = int(brightness/100. * 2000000)

    def read_data(self, bias_color="", bias_constant=0):
        """Reads in raw data directly from color_sensor.

        :param bias_color: One color can be made more sensitive.
            note: May cause false positives.
            recommended values are ~1%
        :param bias_constant: Percentage increase by which to bias.
        :returns: Validity, Clear (magnitude), Red, Green, Blue.

        """
        if not self.testing:
            valid = self.registers['STATUS'].read('AVALID')
            c = self.registers['CDATA'].read()
            r = self.registers['RDATA'].read()
            g = self.registers['GDATA'].read()
            b = self.registers['BDATA'].read()

            if bias_color == "green":
                g *= 1 + bias_constant/100
            elif bias_color == "red":
                r *= 1 + bias_constant/100
            elif bias_color == "blue":
                b *= 1 + bias_constant/100

            return valid, c, r, g, b
        else:
            return 1, 1, 1, 1, 1

    def get_percentage(self):
        """Calculates percentages of total color for each color.

        :returns: Validity, Clear (magnitude), Red, Green, Blue.

        """
        v, c, r, g, b = self.get_data_normalized()
        total = r + g + b
        r = (r / total) * 100
        g = (g / total) * 100
        b = (b / total) * 100
        return v, c, r, g, b

    def get_baseline(self):
        """Obtains "base" colors to work from.

        :raises AssertionError: When Color sensor saw nothing.

        """

        # Repeatedly attempts baseline if zeros are found.
        # Note: if this doesn't work on the first try, something
        # is usually wrong.
        while True:
            self.bv, self.bc, \
            self.br, self.bg, \
            self.bb = self.read_data()
            if self.br != 0 and self.bg != 0 and self.bb != 0:
                break
            self.logger.error("Baseline not found on first attempt.")

    def get_percent_diff(self):
        """Calculates percent difference from baseline.

        :returns: percent differences of brightness, and colors.

        """
        diff_c = (self.color["clear"] - self.bc) / self.bc
        diff_r = (self.color["red"] - self.br) / self.br
        diff_g = (self.color["green"] - self.bg) / self.bg
        diff_b = (self.color["blue"] - self.bb) / self.bb

        diff_g *= 1.01

        return diff_c, diff_r, diff_g, diff_b

    @lib.api_call
    def detects_color(self, color):
        """Checks to see if given color is present.

        :param color: Color to check for.
        :type color: string

        :returns: True if color found. False otherwise.

        """
        diff_c, diff_r, diff_g, diff_b = self.get_percent_diff()

        if color == "green":
            if (diff_g > diff_r) and (diff_g  > diff_b):
                return True
        elif color == "red":
            if (diff_r > diff_g) and (diff_r > diff_b):
                return True
        elif color == "blue":
            if (diff_b > diff_g) and (diff_b > diff_r):
                return True
        else:
            return "Error: Unknown color"

        return False

    @lib.api_call
    def watch_for_color(self, color, timeout=5):
        """Waits for given color to be found.

        :param color: Color to wait for.
        :type color: string
        :param timeout: Maximum time in seconds for which it will wait.
        :type timeout: float
        :returns: True when color is eventually found. False if never found.
        """
        start_time = time.time()

        while time.time() - start_time < timeout:
            if self.detects_color(color):
                return True
        return False

    def detects_color_diff_method(self, color, thresh=0.2):
        """Finds color based on the total % of total color that is seen.

        Each percentage is a fraction of the total color (r+g+b)
        as seen by the color sensor. The percentages all add up
        to 100.

        Note: This is experimental and not recommended for use.

        :param color: Color to search for.
        :type color: string
        :param thresh: Difference in percentage expected.
        :type thresh: float
        :returns: True if color is found. False otherwise.

        """
        # Reads in percentages of total color
        pv, pc, \
        percent_red,\
        percent_green, \
        percent_blue = self.get_percentage()

        total_color = self.color["red"] \
                    + self.color["green"] \
                    + self.color["blue"]

        total_base = self.br + self.bg + self.bb

        # Base percentages for each color
        percent_baser = self.br / total_base * 100
        percent_baseg = self.bg / total_base * 100
        percent_baseb = self.bb / total_base * 100

        # returns True when the percentage of a color goes up by thresh
        if color == "green":
            if percent_green - percent_baseg > thresh:
                return True
        elif color == "red":
            if percent_red - percent_baser > thresh:
                return True
        elif color == "blue":
            if percent_blue - percent_baseb > thresh:
                return True
        else:
            return "Error: Unknown color"
        return False

def read_loop():
    """Instantiate a ColorSensor object and read indefinitely."""
    print "start"
    colorSensor = ColorSensor()

    #gets base values for all colors.
    time.sleep(0.5)
    colorSensor.get_baseline()

    print "bv: {}, bc: {:5.3f}, br: {:5.3f}, bg: {:5.3f}, bb: {:5.3f}".format(colorSensor.bv, \
                                                                            colorSensor.bc,\
                                                                            colorSensor.br,\
                                                                            colorSensor.bg,\
                                                                            colorSensor.bb)

    # self.logger.debug("baseline: bv: {}, bc: {}, br: {}, bg: {}, bb: {}".format(bv, bc, br, bg, bb))

    print "before loop"
    t0 = time.time()
    while True:
        try:
            elapsed = time.time() - t0
            print "[{:8.3f}] ".format(elapsed)
            print "bv: {}, bc: {:5.3f}, br: {:5.3f}, bg: {:5.3f}, bb: {:5.3f}".format(colorSensor.bv, \
                                                                            colorSensor.color["clear"],\
                                                                            colorSensor.color["red"],\
                                                                            colorSensor.color["green"],\
                                                                            colorSensor.color["blue"])
            # if colorSensor.detects_color("green"):
                # print "Found green, Percent method"

            # if colorSensor.is_green_diff_method():
                # print "diff method"

            #print "v: {}  c: {}, r: {}, g: {} b: {}".format(valid, c, r, g, b)
            # v, c, r, g, b = colorSensor.get_data_normalized()  # read normalized RGB values
            #v, c, r, g, b = colorSensor.get_percentage()
            # Find out which color has plurality of percentage.
            # print "v: {}, c: {:5.3f}, r: {:5.3f}, g: {:5.3f}, b: {:5.3f}".format(v, c, r, g, b)

            time.sleep(0.1)
        except KeyboardInterrupt:
            break
    print "Done."

if __name__ == "__main__":
    read_loop()
<|endoftext|>


<commit_before>"""Value change dump stuff."""

from hdltools.sim import HDLSimulationPort

class VCDObject:
    """Abstract VCD object class."""

    def __init__(self, **kwargs):
        """Initialize."""
        pass

class VCDVariable(VCDObject):
    """Variable declaration."""

    def __init__(self, *identifiers, var_type="wire", size=1, name=None):
        """Initialize."""
        super().__init__()
        self._vartype = var_type
        self._size = size
        self._identifiers = identifiers
        self._name = name

    @property
    def var_type(self):
        """Get variable type."""
        return self._vartype

    @property
    def size(self):
        """Get variable size."""
        return self._size

    def __len__(self):
        """Get variable size."""
        return self.size

    @property
    def varid(self):
        """Get variable identifier."""
        return self._identifiers

    @property
    def name(self):
        """Get variable name."""
        return self._name

    def get_first_identifier(self):
        """Get identifier."""
        if isinstance(self.identifiers, (tuple, list)):
            return self._identifiers[0]
        else:
            return self._identifiers

class VCDDump(VCDObject):
    """Complete VCD dump."""

    def __init__(self, name, timescale="1 ns", **kwargs):
        """Initialize."""
        super().__init__(**kwargs)
        self.variables = {}
        self.variable_identifiers = {}
        self.timescale = timescale
        self.name = name
        self.initial = None
        self.vcd = []
        self.var_counter = ord("!")
        self.last_signal_values = None

    def _add_variable(self, var):
        self.variables[chr(self.var_counter)] = var
        self.variable_identifiers[var.get_first_identifier()] = chr(
            self.var_counter
        )
        self.var_counter += 1

    def add_variables(self, *args, **kwargs):
        """Add variables."""
        for arg in args:
            if not isinstance(arg, VCDVariable):
                raise TypeError("only VCDVariable allowed")
            self._add_variable(arg)

        for name, value in kwargs.items():
            if isinstance(value, HDLSimulationPort):
                var = VCDVariable(name, size=value.size)
            else:
                raise TypeError("not allowed")

            self._add_variable(var)

    @staticmethod
    def _combine_signals(sig_tuple):
        sig_dict = {}
        for d in sig_tuple:
            sig_dict.update(d)

        return sig_dict

    @staticmethod
    def _detect_changes(signals, psignals):
        int_signals = {name: int(value) for name, value in signals.items()}
        int_psignals = {name: int(value) for name, value in psignals.items()}
        changes = {}
        for name, value in int_signals.items():
            if value != int_psignals[name]:
                # change detected
                changes[name] = value

        return changes

    def load_dump(self, steps):
        """Load data."""
        for step in steps:
            sim_time, signals = step
            signals = self._combine_signals(signals)

            if sim_time == 0:
                self.initial = signals
                continue

            # look for changes
            if len(self.vcd) == 0:
                changes = self._detect_changes(signals, self.initial)
            else:
                changes = self._detect_changes(
                    signals, self.last_signal_values
                )

            formatted_changes = {}
            for name, value in changes.items():
                if self.variables[self.variable_identifiers[name]].size > 1:
                    formatted_changes[name] = "b{0:b} ".format(value)
                else:
                    formatted_changes[name] = "1" if bool(value) else "0"
            self.vcd.append(formatted_changes)
            self.last_signal_values = signals
<commit_msg>fix code for backwards compatibility<commit_after>"""Value change dump stuff."""

from hdltools.sim import HDLSimulationPort

class VCDObject:
    """Abstract VCD object class."""

    def __init__(self, **kwargs):
        """Initialize."""
        pass

class VCDVariable(VCDObject):
    """Variable declaration."""

    def __init__(self, *identifiers, var_type="wire", size=1, name=None):
        """Initialize."""
        super().__init__()
        self._vartype = var_type
        self._size = size
        self._identifiers = identifiers
        self._name = name

    @property
    def var_type(self):
        """Get variable type."""
        return self._vartype

    @property
    def size(self):
        """Get variable size."""
        return self._size

    def __len__(self):
        """Get variable size."""
        return self.size

    @property
    def varid(self):
        """Get variable identifier."""
        return self._identifiers

    @property
    def name(self):
        """Get variable name."""
        return self._name

    # FIXME: "identifiers" does not make sense, why would it be a list?
    @property
    def identifiers(self):
        """Get identifiers."""
        return self._identifiers

    def get_first_identifier(self):
        """Get identifier."""
        if isinstance(self._identifiers, (tuple, list)):
            return self._identifiers[0]
        else:
            return self._identifiers

class VCDDump(VCDObject):
    """Complete VCD dump."""

    def __init__(self, name, timescale="1 ns", **kwargs):
        """Initialize."""
        super().__init__(**kwargs)
        self.variables = {}
        self.variable_identifiers = {}
        self.timescale = timescale
        self.name = name
        self.initial = None
        self.vcd = []
        self.var_counter = ord("!")
        self.last_signal_values = None

    def _add_variable(self, var):
        self.variables[chr(self.var_counter)] = var
        self.variable_identifiers[var.get_first_identifier()] = chr(
            self.var_counter
        )
        self.var_counter += 1

    def add_variables(self, *args, **kwargs):
        """Add variables."""
        for arg in args:
            if not isinstance(arg, VCDVariable):
                raise TypeError("only VCDVariable allowed")
            self._add_variable(arg)

        for name, value in kwargs.items():
            if isinstance(value, HDLSimulationPort):
                var = VCDVariable(name, size=value.size)
            else:
                raise TypeError("not allowed")

            self._add_variable(var)

    @staticmethod
    def _combine_signals(sig_tuple):
        sig_dict = {}
        for d in sig_tuple:
            sig_dict.update(d)

        return sig_dict

    @staticmethod
    def _detect_changes(signals, psignals):
        int_signals = {name: int(value) for name, value in signals.items()}
        int_psignals = {name: int(value) for name, value in psignals.items()}
        changes = {}
        for name, value in int_signals.items():
            if value != int_psignals[name]:
                # change detected
                changes[name] = value

        return changes

    def load_dump(self, steps):
        """Load data."""
        for step in steps:
            sim_time, signals = step
            signals = self._combine_signals(signals)

            if sim_time == 0:
                self.initial = signals
                continue

            # look for changes
            if len(self.vcd) == 0:
                changes = self._detect_changes(signals, self.initial)
            else:
                changes = self._detect_changes(
                    signals, self.last_signal_values
                )

            formatted_changes = {}
            for name, value in changes.items():
                if self.variables[self.variable_identifiers[name]].size > 1:
                    formatted_changes[name] = "b{0:b} ".format(value)
                else:
                    formatted_changes[name] = "1" if bool(value) else "0"
            self.vcd.append(formatted_changes)
            self.last_signal_values = signals
<|endoftext|>