* Python.Runtime now exposes a public class called DocStringAttribute with usage = AttributeTargets.All

Barton Cline · Barton Cline · commit 015a67997c4e · 2011-04-23T22:50:18.000Z
* Decorating .NET classes and methods has passed initial tests.
diff --git a/pythonnet/src/runtime/classmanager.cs b/pythonnet/src/runtime/classmanager.cs
@@ -131,6 +131,20 @@ private static ClassBase CreateClass(Type type) {
             }
 
             // If class has constructors, generate an __doc__ attribute.
+					
+            IntPtr doc;
+			Type marker = typeof(DocStringAttribute);
+			Attribute[] attrs = (Attribute[])type.GetCustomAttributes(marker, false);
+            if (attrs.Length == 0) {
+            	doc = IntPtr.Zero;
+			}
+			else {
+				DocStringAttribute attr = (DocStringAttribute)attrs[0];
+				string docStr = attr.DocString;
+            	doc = Runtime.PyString_FromString(docStr);
+                Runtime.PyDict_SetItemString(dict, "__doc__", doc);
+                Runtime.Decref(doc);
+			}
 
             ClassObject co = impl as ClassObject;
             // If this is a ClassObject AND it has constructors, generate a __doc__ attribute.
@@ -143,12 +157,14 @@ private static ClassBase CreateClass(Type type) {
                     // XXX deprecate __overloads__ soon...
                     Runtime.PyDict_SetItemString(dict, "__overloads__", ctors.pyHandle);
                     Runtime.PyDict_SetItemString(dict, "Overloads", ctors.pyHandle);
-
-                    IntPtr doc = co.GetDocString();
-                    Runtime.PyDict_SetItemString(dict, "__doc__", doc);
-                    Runtime.Decref(doc);
-                }
-            }
+					
+                    if (doc == IntPtr.Zero) {
+                    	doc = co.GetDocString();
+	                    Runtime.PyDict_SetItemString(dict, "__doc__", doc);
+	                    Runtime.Decref(doc);
+	                }
+				}
+			}
 
             return impl;
         }
diff --git a/pythonnet/src/runtime/interop.cs b/pythonnet/src/runtime/interop.cs
@@ -22,7 +22,7 @@ namespace Python.Runtime {
     //=======================================================================
 
     [Serializable()]
-    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Delegate | AttributeTargets.Property)]
+    [AttributeUsage(AttributeTargets.All)]
     public class DocStringAttribute : Attribute {
         public DocStringAttribute(string docStr) {
 			DocString = docStr;
diff --git a/pythonnet/src/runtime/methodobject.cs b/pythonnet/src/runtime/methodobject.cs
@@ -71,13 +71,21 @@ internal IntPtr GetDocString() {
             if (doc != IntPtr.Zero) {
                 return doc;
             }
-            MethodBase[] methods = binder.GetMethods();
             string str = "";
-            for (int i = 0; i < methods.Length; i++) {
+			Type marker = typeof(DocStringAttribute);
+            MethodBase[] methods = binder.GetMethods();
+            foreach (MethodBase method in methods) {
                 if (str.Length > 0)
                     str += Environment.NewLine;
-                str += methods[i].ToString();
-            }
+				Attribute[] attrs = (Attribute[]) method.GetCustomAttributes(marker, false);
+	            if (attrs.Length == 0) {
+		                str += method.ToString();
+		            }
+				else {
+					DocStringAttribute attr = (DocStringAttribute)attrs[0];
+					str += attr.DocString;
+				}
+			}
             doc = Runtime.PyString_FromString(str);
             return doc;
         }
