Implementing pytest and TravisCI; added docstrings

Author: domdfcoding

.gitignore

@@ -1,4 +1,5 @@
 .idea
 build
 *.egg-info
-*/__pycache__
+*/__pycache__
+.coverage

.travis.yml

@@ -0,0 +1,14 @@
+language: python
+python:
+  - "3.5"
+  - "3.6"
+  - "3.7"
+  - "3.8"
+# command to install dependencies
+install:
+  - pip install -U coveralls pytest
+# command to run tests
+script:
+  - coverage run --source=domdf_python_tools -m pytest
+after_success:
+  - coveralls

domdf_python_tools/__init__.py

@@ -53,15 +53,44 @@ def as_text(value):
 
 
 def str2tuple(input_string, sep=","):
+	"""
+	Convert a comma-seperated string of integers into a tuple
+	
+	:param input_string: The string to be converted into a tuple
+	:type input_string: str
+	:param sep: The separator in the string, default ","
+	:type sep: str
+	
+	:rtype: tuple
+	"""
+	
 	return tuple(int(x) for x in input_string.split(sep))
 
 
 def tuple2str(input_tuple, sep=","):
-	return sep.join(input_tuple)
+	"""
+	Convert a tuple into a comma-seperated string
+
+	:param input_tuple: The tuple to be joined into a string
+	:type input_tuple: tuple
+	:param sep: The separator in the string, default ","
+	:type sep: str
+
+	:rtype: str
+	"""
+	
+	return sep.join([str(x) for x in input_tuple])
 
 
 def chunks(l, n):
-	"""Yield successive n-sized chunks from l."""
+	"""
+	Yield successive n-sized chunks from l.
+	
+	:param l:
+	:param n:
+	:return:
+	"""
+	
 	for i in range(0, len(l), n):
 		yield l[i:i + n]
 

tests/test_init.py

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+"""
+test_init
+~~~~~~~~~~~~~~~
+
+Test functions in __init__.py
+
+"""
+
+import types
+
+from domdf_python_tools import pyversion, str2tuple, tuple2str, chunks, list2str, list2string
+
+def test_pyversion():
+	assert isinstance(pyversion, int)
+
+def test_str2tuple():
+	assert isinstance(str2tuple("1,2,3"), tuple) # tests without spaces
+	assert isinstance(str2tuple("1, 2, 3"), tuple) # tests with spaces
+	assert isinstance(str2tuple("1; 2; 3", sep=";"), tuple) # tests with semicolon
+	if str2tuple("1,2,3") == (1, 2, 3):
+		assert 1
+	else:
+		assert 0
+		
+def test_tuple2str():
+	assert isinstance(tuple2str(("1","2","3",)), str)
+	if tuple2str((1, 2, 3)) == "1,2,3":
+		assert 1
+	else:
+		assert 0
+		
+	assert isinstance(tuple2str((1,2,3,), sep=";"), str) # tests with semicolon
+	if tuple2str((1, 2, 3), sep=";") == "1;2;3":
+		assert 1
+	else:
+		assert 0
+
+def test_chunks():
+	assert isinstance(chunks(list(range(100)), 5), types.GeneratorType)
+	if list(chunks(list(range(100)), 5))[0] == [0,1,2,3,4]:
+		assert 1
+	else:
+		assert 0
+
+
+def test_list2str():
+	assert isinstance(list2str([1, 2, 3,]), str)
+	if list2str([1, 2, 3]) == "1,2,3":
+		assert 1
+	else:
+		assert 0
+	
+	assert isinstance(list2str([1, 2, 3], sep=";"), str)  # tests with semicolon
+	if list2str((1, 2, 3), sep=";") == "1;2;3":
+		assert 1
+	else:
+		assert 0
+	
+	assert isinstance(list2string([1, 2, 3, ]), str)
+	if list2string([1, 2, 3]) == "1,2,3":
+		assert 1
+	else:
+		assert 0
+	
+	assert isinstance(list2string([1, 2, 3], sep=";"), str)  # tests with semicolon
+	if list2string((1, 2, 3), sep=";") == "1;2;3":
+		assert 1
+	else:
+		assert 0
+
+