[Level 2] Pydoc, the document of Python.

In Java, we have javadoc to generate the document,
in Python, we have pydoc.
More info, please click here.


The sample of pydoc as the following:

The source code of testPyDoc.py
#!/usr/bin/python

"""
This is a sample module to generate pydoc
"""
__author__ =  'Stanley Huang'
__version__=  '1.0'

class PyDoc:
    """class docstrings"""
    def __init__ (self, user='guest', addr='Taipei'):
        """Set default attribute values only
        Keyword arguments:
        user -- name of user
        addr -- addr of user
        """
        self.user = user
        self.addr = addr

$ pydoc testPydoc
Help on module testPyDoc:

NAME
    testPyDoc - This is a sample module to generate pydoc

FILE
    /tmp/testPyDoc.py

CLASSES
    PyDoc
    
    class PyDoc
     |  class docstrings
     |  
     |  Methods defined here:
     |  
     |  __init__(self, user='guest', addr='Taipei')
     |      Set default attribute values only
     |      Keyword arguments:
     |      user -- name of user
     |      addr -- addr of user

DATA
    __author__ = 'Stanley Huang'
    __version__ = '1.0'

VERSION
    1.0

AUTHOR
    Stanley Huang
Wish this helps. regards, Stanley Huang

Comments

Post a Comment

Popular posts from this blog

[Level 1] Rar tool for Solaris.

Sometimes we will got a rar compressed file from our friends, but there is no default tool in OpenSolaris to decompress the rar filess. We can got a Solaris Intel version from rarlab . The steps as the following: 1. down load the rar tools from rarlab. http://www.rarlab.com/rar_add.htm 2. uncompressed the source. # gunzip ./unrar-sol-intel.gz 3. move it to the location you used to. # mv /unrar-sol-intel.gz /usr/bin/unrar 4. try to decomprss # unrar x ./test.rar Wish this helps. regards, Stanley Huang
Read more

[Level 2] iif in Python

If you want to implement iif in Python, please refer to the following sample code: #!/bin/env python def iif(b): return 'It\'s True' if b else 'It\'s False' print iif(True) print iif(False) And the following sample, guess what will you get! #!/bin/env python b = True print 'b: %s' % 'Ture' if b else 'False' b = False print 'b: %s' % 'Ture' if b else 'False' Result: $ ./iif.py b: Ture False The second result is "False", not "b: False". Why??? Because the prededence of string concatenation is higher than if. Therefore you need to use () to make it correct. #!/bin/env python b = True print 'b: %s' % 'Ture' if b else 'False' b = False print 'b: %s' % ('Ture' if b else 'False') Wish this helps. regards, Stanley Huang
Read more