Initial skeleton for the traittype repository with naive Array trait type implementation

SylvainCorlay · SylvainCorlay · commit 034dad00f2c1 · 2015-11-11T21:19:12.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -55,3 +55,6 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# OS X
+.DS_Store
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,13 @@
+language: python
+python:
+    - 3.5
+    - 3.4
+    - 2.7
+    - 3.3
+sudo: false
+install:
+    - pip install . coveralls
+script:
+    - nosetests --with-coverage --cover-package traittypes traittypes
+after_success:
+    - coveralls
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,5 @@
-Copyright (c) 2015, 
+Copyright (c) IPython Development Team.
+
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,22 @@
+CONTRIBUTING.md
+README.md
+LICENSE
+
+# Documentation
+graft docs
+exclude docs/\#*
+
+# Examples
+graft examples
+
+# docs subdirs we want to skip
+prune docs/build
+prune docs/gh-pages
+prune docs/dist
+
+# Patterns to exclude from any directory
+global-exclude *~
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude .git
+global-exclude .ipynb_checkpoints
diff --git a/README.md b/README.md
@@ -1,2 +1,12 @@
-# traittypes
-Traitlets types for NumPy, SciPy and friends
+# Scipy Trait Types
+Trait types for NumPy, SciPy and friends
+
+### Goals
+
+Provide a reference implementation of trait types for common data structures used in the scipy stack such as
+ - numpy arrays
+ - pandas / xray data structures
+
+which are out of the scope of the main [traitlets](https://github.com/ipython/traitlets) project but are a common requirement to build applications with traitlets in combination with the scipy stack.
+
+Another goal is to create adequate serialization and deserialization routines for these trait types to be used with the [ipywidgets](https://github.com/ipython/ipywidgets) project (`to_json` and `from_json`). These could also return a list of binary buffers as allowed by the current message protocol. 
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,2 @@
+[bdist_wheel]
+universal=1
diff --git a/setup.py b/setup.py
@@ -0,0 +1,90 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+from __future__ import print_function
+
+# the name of the project
+name = 'traittypes'
+
+#-----------------------------------------------------------------------------
+# Minimal Python version sanity check
+#-----------------------------------------------------------------------------
+
+import sys
+
+v = sys.version_info
+if v[:2] < (2,7) or (v[0] >= 3 and v[:2] < (3,3)):
+    error = "ERROR: %s requires Python version 2.7 or 3.3 or above." % name
+    print(error, file=sys.stderr)
+    sys.exit(1)
+
+PY3 = (sys.version_info[0] >= 3)
+
+#-----------------------------------------------------------------------------
+# get on with it
+#-----------------------------------------------------------------------------
+
+import os
+from glob import glob
+
+from distutils.core import setup
+
+pjoin = os.path.join
+here = os.path.abspath(os.path.dirname(__file__))
+pkg_root = pjoin(here, name)
+
+packages = []
+for d, _, _ in os.walk(pjoin(here, name)):
+    if os.path.exists(pjoin(d, '__init__.py')):
+        packages.append(d[len(here)+1:].replace(os.path.sep, '.'))
+
+version_ns = {}
+with open(pjoin(here, name, '_version.py')) as f:
+    exec(f.read(), {}, version_ns)
+
+
+setup_args = dict(
+    name            = name,
+    version         = version_ns['__version__'],
+    scripts         = glob(pjoin('scripts', '*')),
+    packages        = packages,
+    description     = "Scipy trait types",
+    long_description= "Custom trait types for scientific computing.",
+    author          = 'IPython Development Team',
+    author_email    = 'ipython-dev@scipy.org',
+    url             = 'http://ipython.org',
+    license         = 'BSD',
+    platforms       = "Linux, Mac OS X, Windows",
+    keywords        = ['Interactive', 'Interpreter', 'Shell', 'Web'],
+    classifiers     = [
+        'Intended Audience :: Developers',
+        'Intended Audience :: System Administrators',
+        'Intended Audience :: Science/Research',
+        'License :: OSI Approved :: BSD License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.3',
+    ],
+)
+
+if 'develop' in sys.argv or any(a.startswith('bdist') for a in sys.argv):
+    import setuptools
+
+setuptools_args = {}
+
+install_requires = setuptools_args['install_requires'] = [
+    'traitlets'
+]
+
+extras_require = setuptools_args['extras_require'] = {
+}
+
+if 'setuptools' in sys.modules:
+    setup_args.update(setuptools_args)
+
+if __name__ == '__main__':
+    setup(**setup_args)
diff --git a/traittypes/__init__.py b/traittypes/__init__.py
@@ -0,0 +1,2 @@
+from .traittypes import *
+from ._version import version_info, __version__
diff --git a/traittypes/_version.py b/traittypes/_version.py
@@ -0,0 +1,2 @@
+version_info = (0, 1, 0, 'dev')
+__version__ = '.'.join(map(str, version_info))
diff --git a/traittypes/tests/__init__.py b/traittypes/tests/__init__.py
diff --git a/traittypes/tests/test_traittypes.py b/traittypes/tests/test_traittypes.py
@@ -0,0 +1,33 @@
+# encoding: utf-8
+"""Tests for traittypes.traittypes."""
+
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+from unittest import TestCase
+from traitlets import HasTraits
+from traitlets.tests.test_traitlets import TraitTestBase
+from traittypes import Array
+import numpy as np
+
+
+class ArrayTraitTestBase(TraitTestBase):
+    """A best testing class for numpy trait types.
+
+    :meth:`assertEqual` is overloaded to not use the `__eq__` operator.
+    """
+
+    def assertEqual(self, v1, v2):
+        return np.testing.assert_array_equal(v1, v2)
+
+
+class IntArrayTrait(HasTraits):
+    value = Array().tag(dtype=np.int)
+
+
+class TestIntArray(ArrayTraitTestBase):
+    """Test d-type validation with a ``dtype=np.int``."""
+    obj = IntArrayTrait()
+
+    _good_values = [1, [1, 2, 3], [[1, 2, 3], [4, 5, 6]], np.array([1])]
+    _bad_values = [[1, [0, 0]]]
diff --git a/traittypes/traittypes.py b/traittypes/traittypes.py
@@ -0,0 +1,16 @@
+from traitlets import TraitType, TraitError
+import numpy as np
+
+
+class Array(TraitType):
+
+    """A numpy array trait type."""
+
+    info_text = 'a numpy array'
+
+    def validate(self, obj, value):
+        try:
+            return np.asarray(value, dtype=self.get_metadata('dtype'),
+                              order=self.get_metadata('order'))
+        except (ValueError, TypeError) as e:
+            raise TraitError(e)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+from .traittypes import *`
	`2`	`+from ._version import version_info, __version__`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+version_info = (0, 1, 0, 'dev')`
	`2`	`+__version__ = '.'.join(map(str, version_info))`