pprint in python

http://stackoverflow.com/questions/521532/how-do-i-get-pythons-pprint-to-return-a-string-instead-of-printing http://docs.python.org/2/library/pprint.html

javac -d option

Using "-d" option, you can create a class in a hierarchical directory. "HelloA.java" has "package a.b", with the "-d" option, the class is generated in "testa/build/a/b" directory.

javac -d testa/build -g testa/src/a/b/HelloA.java 
java -cp testa/build a.b.HelloA

Python format string

When using template technique for formatting string, STRING#format can be useful.

print 'Coordinates: {latitude}, {longitude}'.format(latitude='37.24N', longitude='-115.81W')

Coordinates: 37.24N, -115.81W

References

• http://docs.python.org/2/library/string.html

pydoc

You can get all the installed module information using "python modules".

pydoc modules

...
AddressBook         __future__          django              pstats
AppKit              _abcoll             dl                  pty
AppleScriptKit      _ast                doctest             pwd
AppleScriptObjC     _bisect             dumbdbm             py2app
Audio_mac           _builtinSuites      dummy_thread        py2app_tests
Automator           _codecs             dummy_threading     py_compile
BaseHTTPServer      _codecs_cn          easy_install        pyclbr
Bastion             _codecs_hk          email               pydoc
CFNetwork           _codecs_iso2022     encodings           pydoc_data
CFOpenDirectory     _codecs_jp          errno               pyexpat
CGIHTTPServer       _codecs_kr          exceptions          quopri
CalendarStore       _codecs_tw          fcntl               random
Canvas              _collections        filecmp             re
...

pydoc doesn't recognize any special markups. If you want to get more from the docstring, you need other documentation generator such as epydoc, Doxygen, or Sphinx.

References

• http://docs.python.org/2/library/pydoc.html
• How to document Python code properly for Pydoc

Using markdown format with TextMate

You want to execute "pandoc" when "⌘-R" is clicked, what would you do? There are some ideas you need to understand.

• Scope selection
• Activation
• Command
• Environment Variables

Scope selection and Activation

Many of the keys are already assigned, so when you try to use the popular key such as "⌘-R", you need to select the scope. In other words, you need to teach TextMate that when you click "⌘-R" in markdown, it means something special.

Command

In command editor, you can give any UNIX command you want. And many of the predefined environment variables are already given.

Combining the command and variable, you can come up wit the following commands.

/usr/local/bin/pandoc "$TM_FILEPATH" -o "$TM_FILEPATH".html
/usr/bin/open "$TM_FILEPATH".html
echo File: "$TM_FILEPATH"

References

• http://manual.macromates.com/en/environment_variables.html
• Pandoc – an essential tool for Markdown users

python logging

Python logging lets the information is shown to the screen, or written to a file. Without any file setup, the default action is to print out the info to the screen.

You have three levels of logging: debug > info > warning. The strongest level is debug, and the weakest is warning.

import logging

logging.warning('Watch out!') # will print a message to the console
logging.info('I told you so') # will not print anything

You can use "basicConfig()" method to login the info to the file. For level, if you choose "DEBUG", every debug/info/warning message is logged, with "INFO", only info/waring, and so on.

import logging
logging.basicConfig(filename='example.log',level=logging.DEBUG)

logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')

References

• http://docs.python.org/2/howto/logging.html#logging-basic-tutorial

Documentation in python

def foo():
    """A multi-line
    docstring.
    """

def bar():
    """
    A multi-line
    docstring.
    """

References

• http://stackoverflow.com/questions/3898572/what-is-the-best-python-docstring-format