pylearn: doc/v2_planning/API_coding

comparison doc/v2_planning/API_coding_style.txt @ 1170:53340a8df1fa

coding_style: Started to write full code sample

author	Olivier Delalleau <delallea@iro>
date	Fri, 17 Sep 2010 14:37:00 -0400
parents	4f1b9e0a1377
children	fe6c25eb1e37 10bc5ebb5823

comparison

equal deleted inserted replaced

-:ec1e93663656
+:53340a8df1fa
 referring to Pylearn internals.
 Code Sample
 ===========
-The following code sample illustrates many of the coding guidelines one should
+The following code sample illustrates some of the coding guidelines one should
-follow in Pylearn.
+follow in Pylearn. This is still a work-in-progress.
 .. code-block:: python
+#! /usr/env/bin python
+"""Sample code. There may still be mistakes / missing elements."""
+__authors__ = "Olivier Delalleau"
+__copyright__ = "(c) 2010, Universite de Montreal"
+__license__ = "3-clause BSD License"
+__contact__ = "Olivier Delalleau <delallea@iro>"
+# Standard library imports are on a single line.
 import os, sys, time
+# Third-party imports come after standard library imports, and there is
+# only one import per line. Imports are sorted lexicographically.
+import numpy
+import scipy
+import theano
+# Put 'from' imports below.
+from numpy import argmax
+from theano import tensor
+# Application-specific imports come last.
+from pylearn import dataset
+from pylearn.optimization import minimize
+def print_files_in(directory):
+"""Print the first line of each file in given directory."""
+# TODO To be continued...
+def main():
+if len(sys.argv) != 2:
+# Note: conventions on how to display script documentation and
+# parse arguments are still to-be-determined.
+print("""\
+Usage: %s <directory>
+Print first line of each file in given directory (in alphabetic order)."""
+% os.path.basename(sys.argv[0]))
+return 1
+print_files_in(sys.argv[1])
+return 0
+# Top-level executable code should be minimal.
+if __name__ == '__main__':
+sys.exit(main())
 Automatic Code Verification
 ===========================
 Tools will be available to make it easier to automatically ensure that code
 Things still missing from this document, being discussed in coding_style.txt:
 - Proper style for C code and Mercurial commits
 - Enforcing 100% test coverage of the code base
 - Providing ways to add type checking for function arguments
+- Conventions for script usage documentation and argument parsing

Mercurial > pylearn

comparison doc/v2_planning/API_coding_style.txt @ 1170:53340a8df1fa