TODO.code-style

   1 To Do list for improving code idioms
   2 ####################################
   3
   4 To Do
   5 =====
   6
   7 * Ensure all files explicitly opened are closed correctly.
   8
   9 * Encapsulate application state in a class.
  10
  11   * dput.dput.PackageUploadApplication
  12   * dput.dcut.CommandUploadApplication
  13
  14 * Reduce ‘if __name__ == '__main__'’ block to minimum.
  15
  16 * Use idiomatic ‘configparser’ processing.
  17
  18   * Migrate to ‘ConfigParser.read’ method.
  19   * Remove direct query to ‘DEFAULT’ config section.
  20
  21 * Use ‘str.format’ for all string formatting and interpolation.
  22
  23   * Remove usage of ‘%’ formatting operator.
  24
  25 * Use ‘argparse’ for command-line parsing.
  26
  27   * Remove usage of ‘getopt’.
  28
  29 * Use ‘logging’ module throughout for all messages.
  30
  31   * Remove usage of ‘sys.std{out,err}.write’ for debug-level messages.
  32   * Remove usage of ‘sys.std{out,err}.write’ for informational messages.
  33   * Remove usage of ‘sys.std{out,err}.write’ for warning message.
  34   * Remove usage of ‘sys.std{out,err}.write’ for error messages.
  35   * Remove usage of ‘sys.std{out,err}.write’ for critical error messages.
  36
  37
  38 Done
  39 ====
  40
  41 * Remove use of global variables.
  42
  43   * dput.dcut.progname
  44   * dput.dcut.version
  45   * dput.dcut.USAGE
  46   * dput.dput.dput_version
  47   * dput.dput.files_to_remove
  48   * dput.dput.files_to_upload
  49   * dput.dput.USAGE
  50   * dput.dput.config_file
  51   * dput.dput.config
  52   * dput.dput.check_only
  53   * dput.dput.dinstall
  54   * dput.dput.delay_upload
  55   * dput.dput.unsigned_upload
  56   * dput.dput.simulate
  57   * dput.dput.upload_methods
  58
  59 * Use ‘subprocess’ API for all subprocess interaction.
  60
  61   * Remove usage of ‘os.popen3’.
  62   * Migrate ‘os.system’ → ‘subprocess.call’.
  63   * Migrate ‘os.waitpid’ → ‘subprocess.check_call’.
  64   * Migrate ‘os.popen’ → ‘subprocess.Popen’.
  65   * Migrate ‘os.spawnv’ → ‘subprocess.check_call’.
  66
  67 * Use ‘sys.stdout.write’ for all normal output.
  68
  69   * Remove usage of ‘print’ for normal output.
  70
  71 \f
  72 ..
  73     Local variables:
  74     coding: utf-8
  75     mode: text
  76     mode: rst
  77     End:
  78     vim: fileencoding=utf-8 filetype=rst :