Add docstrings skeletons.

[OpenColorIO-Configs.git] / aces_1.0.0 / python / aces_ocio / process.py

diff --git a/aces_1.0.0/python/aces_ocio/process.py b/aces_1.0.0/python/aces_ocio/process.py
index 7660c15..1a3506b 100755 (executable)
--- a/aces_1.0.0/python/aces_ocio/process.py
+++ b/aces_1.0.0/python/aces_ocio/process.py
@@ -25,6 +25,20 @@ __all__ = ['readText',
 \r
 \r
 def readText(textFile):\r
+    """\r
+    Object description.\r
+\r
+    Parameters\r
+    ----------\r
+    parameter : type\r
+        Parameter description.\r
+\r
+    Returns\r
+    -------\r
+    type\r
+         Return value description.\r
+    """\r
+\r
     if (textFile != ""):\r
         fp = open(textFile, 'rb')\r
         # Create a text/plain message\r
@@ -33,9 +47,21 @@ def readText(textFile):
     return text\r
 \r
 \r
-# readText\r
-\r
 def writeText(text, textFile):\r
+    """\r
+    Object description.\r
+\r
+    Parameters\r
+    ----------\r
+    parameter : type\r
+        Parameter description.\r
+\r
+    Returns\r
+    -------\r
+    type\r
+         Return value description.\r
+    """\r
+\r
     if (textFile != ""):\r
         fp = open(textFile, 'wb')\r
         # Create a text/plain message\r
@@ -44,11 +70,9 @@ def writeText(text, textFile):
     return text\r
 \r
 \r
-# readText\r
-\r
 class Process:\r
     """\r
-    A process with logged output\r
+    A process with logged output.\r
     """\r
 \r
     def __init__(self,\r
@@ -58,7 +82,20 @@ class Process:
                  cwd=None,\r
                  env=None,\r
                  batchWrapper=False):\r
-        """Initialize the standard class variables"""\r
+        """\r
+        Initialize the standard class variables.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
+        """\r
+\r
         self.cmd = cmd\r
         if not description:\r
             self.description = cmd\r
@@ -75,9 +112,21 @@ class Process:
         self.batchWrapper = batchWrapper\r
         self.processKeys = []\r
 \r
-    # __init__\r
-\r
     def getElapsedSeconds(self):\r
+        """\r
+        Object description.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
+        """\r
+\r
         import math\r
 \r
         if self.end and self.start:\r
@@ -88,10 +137,21 @@ class Process:
             formatted = None\r
         return formatted\r
 \r
-    # getElapsedtime\r
-\r
     def writeKey(self, writeDict, key=None, value=None, startStop=None):\r
-        "Write a key, value pair in a supported format"\r
+        """\r
+        Writes a key / value pair in a supported format.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
+        """\r
+\r
         if key != None and (value != None or startStop != None):\r
             indent = '\t' * writeDict['indentationLevel']\r
             if writeDict['format'] == 'xml':\r
@@ -107,6 +167,20 @@ class Process:
                     "%s%40s : %s\n" % (indent, key, value))\r
 \r
     def writeLogHeader(self, writeDict):\r
+        """\r
+        Object description.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
+        """\r
+\r
         import platform\r
 \r
         # Retrieve operating environment information\r
@@ -137,7 +211,8 @@ class Process:
 \r
         self.writeKey(writeDict, 'description', self.description)\r
         self.writeKey(writeDict, 'cmd', self.cmd)\r
-        if self.args: self.writeKey(writeDict, 'args', ' '.join(self.args))\r
+        if self.args:\r
+            self.writeKey(writeDict, 'args', ' '.join(self.args))\r
         self.writeKey(writeDict, 'start', self.start)\r
         self.writeKey(writeDict, 'end', self.end)\r
         self.writeKey(writeDict, 'elapsed', self.getElapsedSeconds())\r
@@ -161,17 +236,37 @@ class Process:
 \r
         self.writeKey(writeDict, 'status', self.status)\r
 \r
-    # writeLogHeader\r
-\r
     def writeLogFooter(self, writeDict):\r
+        """\r
+        Object description.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
+        """\r
+\r
         writeDict['indentationLevel'] -= 1\r
         self.writeKey(writeDict, 'process', None, 'stop')\r
 \r
-    # writeLogFooter\r
-\r
     def writeLog(self, logHandle=sys.stdout, indentationLevel=0, format='xml'):\r
         """\r
-        Write logging information to the specified handle\r
+        Writes logging information to the specified handle.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
         """\r
 \r
         writeDict = {}\r
@@ -194,9 +289,21 @@ class Process:
 \r
             self.writeLogFooter(writeDict)\r
 \r
-    # writeLog\r
-\r
     def writeLogToDisk(self, logFilename=None, format='xml', header=None):\r
+        """\r
+        Object description.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
+        """\r
+\r
         if logFilename:\r
             try:\r
                 # This also doesn't seem like the best structure...\r
@@ -220,21 +327,40 @@ class Process:
             self.writeLog(logHandle)\r
             logHandle.close()\r
 \r
-    # writeLogToDisk\r
-\r
     def logLine(self, line):\r
-        "Add a line of text to the log"\r
+        """\r
+        Adds a line of text to the log.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
+        """\r
+\r
         self.log.append(line.rstrip())\r
         if self.echo:\r
             print("%s" % line.rstrip())\r
 \r
-    # logLine\r
-\r
     def execute(self):\r
         """\r
-        Execute this process\r
+        Executes the current process.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
         """\r
-        import re\r
+\r
         import datetime\r
         import traceback\r
 \r
@@ -363,28 +489,48 @@ class Process:
             self.status = exitCode\r
 \r
         self.end = datetime.datetime.now()\r
-        # execute\r
 \r
 \r
-# Process\r
-\r
 class ProcessList(Process):\r
     """\r
-    A list of processes with logged output\r
+    A list of processes with logged output.\r
     """\r
 \r
     def __init__(self, description, blocking=True, cwd=None, env=None):\r
+        """\r
+        Object description.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
+        """\r
+\r
         Process.__init__(self, description, None, None, cwd, env)\r
         "Initialize the standard class variables"\r
         self.processes = []\r
         self.blocking = blocking\r
 \r
-    # __init__\r
-\r
     def generateReport(self, writeDict):\r
         """\r
-        Generate a log based on the success of the child processes\r
+        Generates a log based on the success of the child processes.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
         """\r
+\r
         if self.processes:\r
             _status = True\r
             indent = '\t' * (writeDict['indentationLevel'] + 1)\r
@@ -417,6 +563,20 @@ class ProcessList(Process):
             self.status = -1\r
 \r
     def writeLogHeader(self, writeDict):\r
+        """\r
+        Object description.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
+        """\r
+\r
         self.writeKey(writeDict, 'processList', None, 'start')\r
         writeDict['indentationLevel'] += 1\r
 \r
@@ -429,17 +589,37 @@ class ProcessList(Process):
 \r
         self.writeKey(writeDict, 'status', self.status)\r
 \r
-    # writeLogHeader\r
-\r
     def writeLogFooter(self, writeDict):\r
+        """\r
+        Object description.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
+        """\r
+\r
         writeDict['indentationLevel'] -= 1\r
         self.writeKey(writeDict, 'processList', None, 'stop')\r
 \r
-    # writeLogFooter\r
-\r
     def writeLog(self, logHandle=sys.stdout, indentationLevel=0, format='xml'):\r
         """\r
-        Write logging information to the specified handle\r
+        Writes logging information to the specified handle.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
         """\r
 \r
         writeDict = {}\r
@@ -464,12 +644,21 @@ class ProcessList(Process):
 \r
             self.writeLogFooter(writeDict)\r
 \r
-    # writeLog\r
-\r
     def execute(self):\r
         """\r
-        Execute this list of processes\r
+        Executes the list of processes.\r
+\r
+        Parameters\r
+        ----------\r
+        parameter : type\r
+            Parameter description.\r
+\r
+        Returns\r
+        -------\r
+        type\r
+             Return value description.\r
         """\r
+\r
         import datetime\r
 \r
         self.start = datetime.datetime.now()\r
@@ -493,12 +682,23 @@ class ProcessList(Process):
                         break\r
 \r
         self.end = datetime.datetime.now()\r
-        # execute\r
-\r
 \r
-# ProcessList\r
 \r
 def main():\r
+    """\r
+    Object description.\r
+\r
+    Parameters\r
+    ----------\r
+    parameter : type\r
+        Parameter description.\r
+\r
+    Returns\r
+    -------\r
+    type\r
+         Return value description.\r
+    """\r
+\r
     import optparse\r
 \r
     p = optparse.OptionParser(description='A process logging script',\r