Inital packaged version

borntyping · borntyping · commit f82cdc4ee0e4 · 2012-11-25T12:46:51.000Z
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+MANIFEST
+dist/*
+build/*
+*.egg-info/*
+*.pyc
diff --git a/README.md b/README.md
@@ -0,0 +1,58 @@
+# `argumented`
+
+`argumented` provides a way of 'multiplying' functions - usually test cases - allowing them to be called with multiple argument sets and still appear as seperate functions.
+
+It provides several decorators that can be used to add argument sets, and then unpack them.
+
+## Decorators
+
+The argument decorators can be used multiple times, or used together - each of them takes the arguments they are given and passes it to `pack_arguments(func, *args, **kwargs)`, which adds a wrapped function to `func.__argumented__`.
+
+#### `@argument(*args, **kwargs)`
+
+Adds the given argument set
+
+#### `@argument_list(*args)`
+
+Adds each item in args as an argument set
+
+#### `@argument_tuples(*args)`
+
+Each item in `*args` must be a tuple containing an interable and a mapping, which will then be used as an argument set (i.e. `([], {})`)
+
+#### `@unpack_arguments`
+
+Unpacks all of the argument sets in a class, replacing each function with a list of argument sets with wrapped functions that call each argument set. The wrapped functions are named `{original name}_{argument set index}`.
+
+## Example
+
+In the following example, each test cases would be replaced with two test cases, which would each call the test case with the given arguments.
+
+	from unittest import TestCase
+	from argumented import *
+
+	@unpack_arguments
+	class TestArgumentedCases (TestCase):
+			
+		@argument("hello", thing="world")
+		@argument("goodbye", thing="world")
+		def test_greeting (self, greeting, thing):
+			self.assertIn(greeting, ["hello", "goodbye"])
+			self.assertEquals(thing, "world")
+		
+		@argument_list(1, 2)
+		def test_with_arguments (self, n):
+			self.assertIsInstance(n, int)
+		
+		@argument_tuples( ([1, 2], {'a': 'A'}), ([1, 2], {'a': 'B'}) )
+		def test_with_arguments (self, *args, **kwargs):
+			self.assertEquals(args, (1, 2))
+			self.assertIn(kwargs['a'], ['A', 'B'])
+
+This example can also be found in `argumented/test_example.py`.
+
+## License
+
+`argumented` is licensed under the MIT License.
+
+`argumented` was originally inspired by [ddt](http://github.com/santtu/ddt).
diff --git a/argumented/__init__.py b/argumented/__init__.py
@@ -0,0 +1,5 @@
+""" Multiply test cases or functions into several functions with argument sets """
+
+from argumented import *
+
+__version__ = "1.0.0"
diff --git a/argumented/argumented.py b/argumented/argumented.py
@@ -1,50 +1,9 @@
 """
-`argumented` provides a way of 'multiplying' functions - usually test cases -
-allowing them to be called with multiple argument sets and still appear as
-seperate test cases.
-
-In the following example, each of the test cases would be replaced with two test
-cases, each of which would call the test case with the given arguments.
-
-`@argument(*args, **kwargs)`
-
-Will call the test case with the given argument set
-
-`@argument_list(*args)`
-
-Will call the test case with each item in `*args`
-
-`@argument_tuples(*args)`
-
-Each item in `*args` must be a tuple containing an interable and a mapping,
-which will then be used as an argument set for the test case (i.e. `([], {})`)
-
-The decorators can be used multiple times, or used together - each of them 
-takes the arguments they are given and passes it to `pack_arguments(func, *args,
-**kwargs)`, which adds a wrapped function to `func.__argumented__`.
-
-	@unpack_arguments
-	class TestArgumentedCases (unittest.TestCase):
-			
-		@argument("hello", thing="world")
-		@argument("goodbye", thing="world")
-		def test_greeting (self, greeting, thing):
-			self.assertIn(greeting, ["hello", "goodbye"])
-			self.assertEquals(thing, "world")
-		
-		@argument_list(1, 2)
-		def test_with_arguments (self, n):
-			self.assertIsInstance(n, int)
-		
-		@argument_tuples( ([1, 2], {'a': 'A'}), ([1, 2], {'a': 'B'}) )
-		def test_with_arguments (self, *args, *kwargs):
-			self.assertEquals(args, (1, 2))
-			self.assertIn(kwargs['a'], ['A', 'B'])
-			
-Originally inspired by [github.com/santtu/ddt](http://github.com/santtu/ddt),
-though it ended up working somewhat diffrently.
+Pack and unpack functions into a set of wrapped functions with set arguments
 """
 
+__all__ = ['unpack_arguments', 'argument', 'argument_list', 'argument_tuples']
+
 from functools import wraps
 
 def unpack_arguments (cls):
diff --git a/argumented/test_example.py b/argumented/test_example.py
@@ -0,0 +1,22 @@
+"""	A set of example tests for `argumented` """
+
+from unittest import TestCase
+from argumented import *
+
+@unpack_arguments
+class TestArgumentedCases (TestCase):
+		
+	@argument("hello", thing="world")
+	@argument("goodbye", thing="world")
+	def test_greeting (self, greeting, thing):
+		self.assertIn(greeting, ["hello", "goodbye"])
+		self.assertEquals(thing, "world")
+	
+	@argument_list(1, 2)
+	def test_with_arguments (self, n):
+		self.assertIsInstance(n, int)
+	
+	@argument_tuples( ([1, 2], {'a': 'A'}), ([1, 2], {'a': 'B'}) )
+	def test_with_arguments (self, *args, **kwargs):
+		self.assertEquals(args, (1, 2))
+		self.assertIn(kwargs['a'], ['A', 'B'])
diff --git a/setup.py b/setup.py
@@ -0,0 +1,26 @@
+from distutils.core import setup
+from argumented import __version__, __doc__
+
+setup(
+    name             = 'argumented',
+    version          = __version__,
+    description      = __doc__,
+    long_description = open("README.md").read(),
+
+    author           = 'Sam Clements',
+    author_email     = 'sam@borntyping.co.uk',
+    url              = 'https://github.com/borntyping/argumented',
+    license          = 'MIT License',
+
+    packages         = ['argumented'],
+
+    classifiers      = [
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2',
+        'Topic :: Software Development :: Testing'
+    ],
+)

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +MANIFEST
 +dist/*
 +build/*
 +*.egg-info/*
 +*.pyc