TODO.code-style

   1 To Do list for improving code idioms
   2 ####################################
   3
   4 To Do
   5 =====
   6
   7 * Remove all use of global variables.
   8
   9 * Reduce ‘if __name__ == '__main__'’ block to minimum.
  10
  11 * Use idiomatic ‘configparser’ processing.
  12
  13   * Remove direct query to ‘DEFAULT’ config section.
  14
  15 * Use ‘str.format’ for all string formatting and interpolation.
  16
  17   * Remove usage of ‘%’ formatting operator.
  18
  19 * Use ‘argparse’ for command-line parsing.
  20
  21   * Remove usage of ‘getopt’.
  22
  23 * Use ‘logging’ module throughout for all messages.
  24
  25   * Remove usage of ‘print’ for debug-level messages.
  26   * Remove usage of ‘print’ for Informational messages.
  27   * Remove usage of ‘print’ for warning message.
  28   * Remove usage of ‘print’ for error messages.
  29   * Remove usage of ‘print’ for critical error messages.
  30
  31 * Use ‘sys.stdout.write’ for all normal output.
  32
  33   * Remove usage of ‘print’ for normal output.
  34
  35 * Use ‘subprocess’ API for all subprocess interaction.
  36
  37   * Remove usage of ‘os.system’.
  38   * Remove usage of ‘os.spawnv’.
  39   * Remove usage of ‘os.popen’.
  40   * Remove usage of ‘os.waitpid’.
  41
  42 * Use a Python native SSH library (e.g. Paramiko or Spur).
  43
  44   * Remove usage of subprocess for SSH.
  45
  46 * Use a Python native GnuPG library (e.g. ‘python-gnupg’).
  47
  48   * Remove usage of subprocess for GnuPG.
  49
  50
  51 Done
  52 ====
  53
  54 * Remove all use of global variables.
  55
  56   * dput.dcut.progname
  57   * dput.dcut.version
  58   * dput.dcut.USAGE
  59   * dput.dput.dput_version
  60   * dput.dput.files_to_remove
  61   * dput.dput.USAGE
  62
  63 * Use ‘subprocess’ API for all subprocess interaction.
  64
  65   * Remove usage of ‘os.popen3’.
  66
  67 \f
  68 ..
  69     Local variables:
  70     coding: utf-8
  71     mode: text
  72     mode: rst
  73     End:
  74     vim: fileencoding=utf-8 filetype=rst :