added basic project

Author: PythonCHB

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+build/*
+di.so
+*.pyc

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2007 Bill Bumgarner <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.rst

@@ -0,0 +1,75 @@
+Copyright 2007 Bill Bumgarner All Rights Reserved.
+Copyright 2014 Christopher Barker All Rights Reserved.
+
+MIT License -- Free as in "free".
+
+
+This is a verison of Bill Bumgarner's "di" module.
+
+http://www.friday.com/bbum/2007/08/24/python-di/
+http://svn.red-bean.com/bbum/trunk/hacques/di/
+
+This is the di module as is, with the addition of another function::
+
+  ref_by_id()
+
+``di(i)`` returns an object given its id ( as returned by ``id(obj)`` ).
+
+``ref_by_id(i)`` returns the reference count of the the object by its id.
+
+This is useful for debugging memory leaks, reference counting errors, etc.
+For instance, if you have a circular reference, objects can never have
+their reference count reduced to zero, and thsu will never be deleted.
+But all references to them maybe have been, so there is no way to get
+their reference count info in the usual way.
+
+Note that both of these functions are very dangerous -- if you pass in
+an invalid id, you can (will!) get a segmentation fault and a hard crash.
+
+Usage::
+
+    >>> obj = {'a' : 'b', 1 : 2}
+    >>> from di import di, ref_by_id
+    >>> id(obj)
+    681856
+    >>> di(681856)
+    {'a': 'b', 1: 2}
+
+    >>> obj = ['a', 'list', 'of', 'stuff']
+    >>> obj_id = id(obj)
+    >>> ref_by_id(obj_id)
+    1
+    >>> a = b = c = obj
+    >>> ref_by_id(obj_id)
+    4
+    >>> del obj
+    >>> ref_by_id(obj_id)
+    3
+    >>> del b,c
+    >>> ref_by_id(obj_id)
+    1
+    >>> del a
+    >>> ref_by_id(obj_id)
+    0
+
+
+Don't use this in production code.  That would be stupid.
+This is, however, very useful for debugging purposes.
+
+Building
+---------
+
+The usual setup.py dance::
+
+  python setup.py build_ext --inplace
+
+will build it in place.
+
+To install::
+
+  python setup.py install
+
+Or in develop mode:
+
+    python setup.py develop
+

di.c

@@ -0,0 +1,78 @@
+#include <Python/Python.h>
+#include <stdio.h> /* for printf*/
+
+PyDoc_STRVAR(di_di_doc,
+             "Given the result of id(), returns a Python object reference.");
+
+static PyObject *
+di_di(PyObject *self, PyObject *args)
+{
+    PyObject *obj;
+    if (!PyArg_ParseTuple(args, "l:di", &obj))
+        return  NULL;
+
+    Py_INCREF(obj);
+    return obj;
+}
+
+PyDoc_STRVAR(di_ref_by_id_doc,
+             "returns the refcount of the python object with the given id.");
+
+static PyObject *
+di_ref_by_id(PyObject *self, PyObject *args)
+{
+    PyObject *obj;
+    PyObject *refcount;
+
+    if (!PyArg_ParseTuple(args, "l:di", &obj))
+        return  NULL;
+
+    refcount = PyInt_FromLong(Py_REFCNT(obj));
+
+    Py_INCREF(refcount); /* Is this required? */
+    return refcount;
+}
+
+
+static PyMethodDef di_methods[] = {
+	{"di", di_di, METH_VARARGS, di_di_doc},
+    {"ref_by_id", di_ref_by_id, METH_VARARGS, di_ref_by_id_doc},
+    {NULL, NULL}
+};
+
+PyDoc_STRVAR(di_doc, "Convert id() back to an object.");
+
+PyMODINIT_FUNC
+initdi(void)
+{
+	PyObject *m;
+
+	m = Py_InitModule3("di", di_methods, di_doc);
+	if (m == NULL) return;
+}
+
+/*
+
+The MIT License
+
+Copyright (c) 2007 Bill Bumgarner <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+*/

setup.py

@@ -0,0 +1,18 @@
+from distutils.core import setup
+from distutils.extension import Extension
+setup(
+    name = 'di',
+    version = '0.1',
+    description = 'Turn an id() back into a Python object reference.',
+    long_description = 'Turn an id() back into a Python object reference.  Kind of like running with scissors.',
+    maintainer = 'Bill Bumgarner',
+    maintainer_email = '[email protected]',
+    license = 'MIT',
+    ext_modules=[
+        Extension(
+            'di',
+            ['di.c'],
+        ),
+    ],
+)
+

test_di.py

@@ -0,0 +1,44 @@
+#!/usr/bin/vn python
+
+"""
+some really simple test code
+
+mostly to assure you that it compiled
+"""
+
+from di import di, ref_by_id
+
+
+def test_di_1():
+
+    obj = {'a': 'b', 1: 2}
+    obj_id = id(obj)
+    assert di(obj_id) == obj
+
+
+def test_ref_by_id_1():
+    obj = ['a', 'list', 'of', 'stuff']
+    obj_id = id(obj)
+    assert ref_by_id(obj_id) == 1
+
+
+def test_ref_by_id_2():
+    """ does a few more counts """
+    obj = ['a', 'list', 'of', 'stuff']
+    obj_id = id(obj)
+
+    assert ref_by_id(obj_id) == 1
+
+    a = b = c = obj
+    assert ref_by_id(obj_id) == 4
+
+    del obj
+    assert ref_by_id(obj_id) == 3
+
+    del b,c
+    assert ref_by_id(obj_id) == 1
+
+    del a
+    assert ref_by_id(obj_id) == 0 # note: dangerous!
+    ## if that memory location gets re-used, this will break!
+    ## and could segfault hard.