bee_python 0.0.3 → 0.0.4

data/egg/script/pylint.cfg

@@ -0,0 +1,236 @@
+[MASTER]
+
+# Specify a configuration file.
+#rcfile=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Profiled execution.
+profile=no
+
+# Add <file or directory> to the black list. It should be a base name, not a
+# path. You may set this option multiple times.
+ignore=CVS
+
+# Pickle collected data for later comparisons.
+persistent=no
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+
+[MESSAGES CONTROL]
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time.
+#enable=E0611,E1103,E1124,E1122,E1123,E9906,E9904,E9905,E9902,E9903,E9900,E9901,E0202,E0203,E1001,E0221,E0222,E1101,E1121,E0001,E0710,E0711,E1003,E0103,E1120,E0602,E0701,E0601,E0101,E0100,E0102,E0105,E0104,E0107,E0106,E0503,E0501,E0502,E0211,E0213,E1111,E1002,E0012,E0011,E0702,E1102
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifier separated by comma (,) or put this option
+# multiple time.
+disable=C0103,C0111,C0112,C0121,C0202,C0203,C0323,C0324,C0301,I0011,R0201,R0801,R0902,R0903,R0904,R0911,R0912,R0913,R0914,R0915,W0102,W0142,W0603,W0703,W0201,E1101,W0232
+
+[REPORTS]
+
+# Set the output format. Available formats are text, parseable, colorized, msvs
+# (visual studio) and html
+output-format=text
+
+# Include message's id in output
+include-ids=yes
+
+# Put messages in a separate file for each module / package specified on the
+# command line instead of printing them on stdout. Reports (if any) will be
+# written in a file name "pylint_global.[txt|html]".
+files-output=no
+
+# Tells whether to display a full report or only the messages
+reports=no
+
+# Python expression which should return a note less than 10 (10 is the highest
+# note). You have access to the variables errors warning, statement which
+# respectively contain the number of errors / warnings messages and the total
+# number of statements analyzed. This is used by the global evaluation report
+# (R0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Add a comment according to your evaluation note. This is used by the global
+# evaluation report (R0004).
+comment=no
+
+
+[BASIC]
+
+# Required attributes for module, separated by a comma
+required-attributes=
+
+# List of builtins function names that should not be used, separated by a comma
+bad-functions=map,filter,apply,input
+
+# Regular expression which should only match correct module names
+module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
+
+# Regular expression which should only match correct module level names
+const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
+
+# Regular expression which should only match correct class names
+class-rgx=[A-Z_][a-zA-Z0-9]+$
+
+# Regular expression which should only match correct function names
+function-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct method names
+method-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct instance attribute names
+attr-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct argument names
+argument-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct variable names
+variable-rgx=[a-z_][a-z0-9_]{1,30}$
+
+# Regular expression which should only match correct list comprehension /
+# generator expression variable names
+inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=i,j,k,e,ex,Run,_
+
+# Bad variable names which should always be refused, separated by a comma
+bad-names=foo,bar,baz,toto,tutu,tata
+
+# Regular expression which should only match functions or classes name which do
+# not require a docstring
+no-docstring-rgx=__.*__
+
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=78
+
+# Maximum number of lines in a module
+max-module-lines=1000
+
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
+# tab).
+indent-string='    '
+
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+
+[VARIABLES]
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching names used for dummy variables (i.e. not used).
+dummy-variables-rgx=_|dummy
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+
+[TYPECHECK]
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# List of classes names for which member attributes should not be checked
+# (useful for classes with attributes dynamically set).
+ignored-classes=SQLObject,MySQLdb
+
+# When zope mode is activated, add a predefined set of Zope acquired attributes
+# to generated-members.
+zope=no
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E0201 when accessed.
+generated-members=REQUEST,acl_users,aq_parent
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,XXX,TODO
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method
+max-args=5
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore
+ignored-argument-names=_.*
+
+# Maximum number of locals for function / method body
+max-locals=15
+
+# Maximum number of return / yield for function / method body
+max-returns=6
+
+# Maximum number of branch for function / method body
+max-branchs=12
+
+# Maximum number of statements in function / method body
+max-statements=50
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+
+[CLASSES]
+
+# List of interface methods to ignore, separated by a comma. This is used for
+# instance to not check methods defines in Zope's Interface base class.
+ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,__new__,setUp
+
+
+[IMPORTS]
+
+# Deprecated modules which should not be used, separated by a comma
+deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled)
+import-graph=
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled)
+ext-import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled)
+int-import-graph=
+

data/egg/script.yml

@@ -1,22 +1,18 @@
-- build: script
-  default: all
+- build:        script
+  default:      all
   description: "Generate a Python script project"
 
 - properties:
-    name: test
-    description: |
-      This script will create a template project for a Python script. Generated
-      build file provides targets 'check' to check Python scripts syntax,
-      'zip' to create distribution archive and 'clean' to delete generated
-      files.
+    name:        script
+    description: This script will generate a Python script project.
 
-- target: welcome
+- target:      welcome
   description: "Print information message"
   script:
   - print: :description
 
-- target: prompt
-  depends: welcome
+- target:      prompt
+  depends:     welcome
   description: "Prompt for project information"
   script:
   - print: "Please answer following questions to generate the project:"
@@ -25,8 +21,8 @@
       default: :name
       property: name
 
-- target: generate
-  depends: prompt
+- target:      generate
+  depends:     prompt
   description: "Generate project"
   script:
   - print: "Generating project..."
@@ -34,11 +30,18 @@
       error "A directory named '#{name}' already exists, aborting" if
         File.exists?("#{here}/#{name}")
   - mkdir: "#{here}/#{name}"
-  - erb: { src: "#{base}/script/build.erb", dest: "#{here}/#{name}/build.yml" }
-  - cp: { src: "#{base}/script/script.py", dest: "#{here}/#{name}/#{name}.py" }
+  - erb:
+      src:  "#{base}/script/build.erb"
+      dest: "#{here}/#{name}/build.yml"
+  - cp:
+      src:  "#{base}/script/script.py"
+      dest: "#{here}/#{name}/#{name}.py"
+  - cp:
+      src:  "#{base}/script/pylint.cfg"
+      dest: "#{here}/#{name}/"
 
-- target: customization
-  depends: generate
+- target:      customization
+  depends:     generate
   description: "Print information about project customization"
   script:
   - print: |
@@ -46,5 +49,6 @@
       the project directory to print information about generated build file.
       Enjoy!
 
-- target: all
+- target:  all
   depends: [welcome, prompt, generate, customization]
+

data/egg/source/source.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# coding=UTF-8
+# encoding=UTF-8
 
 """Sample Hello World Python script."""
 
@@ -12,14 +12,14 @@ Say hello:
 -h    Print this help page.
 -w    Who to say hello to.""" % sys.argv[0]
 
-def say_hello(person):
+def main(who):
     """Say hello.
     - person: who to say hello to."""
-    return "Hello %s!" % person
+    return "Hello %s!" % who
 
 # parse command line
 if __name__ == '__main__':
-    who = "World"
+    _who = "World"
     try:
         OPTS, ARGS = getopt.getopt(sys.argv[1:],
                                    "hw:",
@@ -33,10 +33,10 @@ if __name__ == '__main__':
             print HELP
             sys.exit(0)
         elif OPT == "-w":
-            who = ARG
+            _who = ARG
         else:
             print "Unhandled option: %s" % OPT
             print HELP
             sys.exit(1)
-    print say_hello(who)
+    print main(_who)
 

data/egg/test/test.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# coding=UTF-8
+# encoding=UTF-8
 
 """Sample Python unit test."""
 

data/lib/bee_task_python.rb

@@ -71,8 +71,6 @@ module Bee
       # - src: directory or list of directories containing Python source
       #   files to check.
       # - options: custom options to use on command line (optional).
-      # - installed: ask to use Pychecker installed in Python VM. Optional,
-      #   defaults to false.
       # - lenient: if set to true, doesn't interrupt the build on error.
       #   Optional, defaults to false.
       # - only: Tells if we must only check sources passed as parameters.
@@ -88,8 +86,6 @@ module Bee
         params_desc = {
           :src       => { :mandatory => true,  :type => :string_or_array },
           :options   => { :mandatory => false, :type => :string },
-          :installed => { :mandatory => false, :type => :boolean,
-                          :default   => false },
           :lenient   => { :mandatory => false, :type => :boolean,
                           :default   => false },
           :only      => { :mandatory => false, :type => :boolean,
@@ -98,7 +94,6 @@ module Bee
         check_parameters(params, params_desc)
         src       = params[:src]
         options   = params[:options]
-        installed = params[:installed]
         lenient   = params[:lenient]
         only      = params[:only]
         # build the list of python source files
@@ -111,12 +106,7 @@ module Bee
         files.uniq!
         # run pychecker command
         puts "Checking #{files.length} Python source file(s)"
-        if installed
-          command = "pychecker"
-        else
-          pychecker = "#{File.dirname(__FILE__)}/../tools/pychecker"
-          command = "python #{pychecker}/checker.py"
-        end
+        command = "pychecker"
         command += " #{options}" if options
         command += " --only" if only
         command += " #{files.join(' ')}"
@@ -134,8 +124,6 @@ module Bee
       # - path: a list of additional directories to include in Python path.
       #   Optional, defaults to no directory.
       # - options: custom options to use on command line (optional).
-      # - installed: ask to use Pylint installed in Python VM. Optional,
-      #   defaults to false.
       # - lenient: if set to true, doesn't interrupt the build on error.
       #   Optional, defaults to false.
       # - config: configuration file name. Optional.
@@ -151,8 +139,6 @@ module Bee
           :files     => { :mandatory => false, :type => :string_or_array },
           :path      => { :mandatory => false, :type => :string_or_array },
           :options   => { :mandatory => false, :type => :string },
-          :installed => { :mandatory => false, :type => :boolean,
-                          :default   => false },
           :lenient   => { :mandatory => false, :type => :boolean,
                           :default   => false },
           :config    => { :mandatory => false, :type => :string_or_array },
@@ -162,7 +148,6 @@ module Bee
         files     = params[:files]
         path      = params[:path]
         options   = params[:options]
-        installed = params[:installed]
         lenient   = params[:lenient]
         config    = params[:config]
         # build the list of python source files
@@ -191,12 +176,7 @@ module Bee
         files.uniq!
         # run pylint command
         puts "Checking #{files.length} Python source file(s)"
-        if installed
-          command = "pylint"
-        else
-          pylint = "#{File.dirname(__FILE__)}/../tools/pylint2/pylint.py"
-          command = "python #{pylint}"
-        end
+        command = "pylint"
         command += " --rcfile=#{config}" if config
         command += " #{options}" if options
         command += " #{files.join(' ')}"
@@ -211,8 +191,6 @@ module Bee
       #   files to doc for.
       # - dest: destination directory for generated documentation.
       # - options: custom options to use on command line (optional).
-      # - installed: ask to use Pychecker installed in Python VM. Optional,
-      #   defaults to false.
       #
       # Example
       #
@@ -225,14 +203,11 @@ module Bee
           :src       => { :mandatory => true,  :type => :string_or_array },
           :dest      => { :mandatory => true,  :type => :string },
           :options   => { :mandatory => false, :type => :string },
-          :installed => { :mandatory => false, :type => :boolean, 
-                          :default => false }
         }
         check_parameters(params, params_desc)
         src       = params[:src]
         dest      = params[:dest]
         options   = params[:options]
-        installed = params[:installed]
         # build the list of python source files
         src = Array(src)
         files = []
@@ -247,13 +222,7 @@ module Bee
           File.directory?(dest) and File.writable?(dest)
         # run epydoc command
         puts "Generating doc for #{files.length} Python source file(s)"
-        if installed
-          command = "epydoc"
-        else
-          epydoc = "#{File.dirname(__FILE__)}/../tools/epydoc"
-          add_python_path("#{epydoc}/..")
-          command = "python #{epydoc}/cli.py"
-        end
+        command = "epydoc"
         command += " -o #{dest}"
         command += " #{options}" if options
         command += " #{files.join(' ')}"

data/python.yml

@@ -0,0 +1,123 @@
+# Build information
+- build:       python
+  description: Parent build file for Python projects
+  abstract:    true
+  default: [clean, test]
+  alias:
+    test:  [py_check, py_test]
+    doc:   [py_doc, py_cover]
+    run:   py_run
+    clean: py_clean
+
+# Build properties
+- properties:
+    # Directory where live generated files
+    py_build_dir:   "build"
+    # Python source directory
+    py_src:         "src"
+    # Python test directory
+    py_tst:         "test"
+    # Python version (regular expression, such as "^2\.[67]" to accept Python 
+    # 2.6 and 2.7, not checked if property not set)
+    py_version:     ~
+    # list of directories with Python source files to check
+    py_chk_src:     [:py_src, :py_tst]
+    # list of Python files to check
+    py_chk_files:   ""
+    # directories to include in Python path while checking
+    py_chk_path:    [:py_src, :py_test]
+    # tells if Python source check is lenient
+    py_chk_len:     false
+    # Pylint options
+    py_chk_opt:     "--generated-members=objects"
+    # Pylint configuration file
+    py_chk_cfg:     "pylint.cfg"
+    # Python test source files
+    py_tst_inc:     "test_*.py"
+    # list of directories with Python source files to document
+    py_doc_src:     [:py_src, :py_tst]
+    # directory where to generate source documentation
+    py_doc_dir:     "#{py_build_dir}/epydoc"
+    # Python documentation option
+    py_doc_opt:     "-v"
+    # Directory where to generate Python coverage report
+    py_cov_dir:     "#{py_build_dir}/coverage"
+    # List of file patterns to include in report
+    py_cov_inc:     ["*.py"]
+    # main scrip to run
+    py_main:        "#{py_src}/#{name}.py"
+    # directories to clean
+    py_clean_dirs:  [:py_build_dir]
+    # files to clean
+    py_clean_files:
+    - "**/*.pyc"
+    - "**/*.pyo"
+
+# Build targets
+- target:      py_version
+  description: Check Python version (if property 'py_version' is defined)
+  script:
+  - if: "defined?(py_version)"
+    then:
+    - print: "Checking python version..."
+    - if:    '!(py_version =~ /^\d+(\.\d+(\.\d+)?)?$/)'
+      then:
+      - throw: "Python version must be of the form 'x' or 'x.y' or 'x.y.z'"
+    - if:    '!(`python -V 2>&1`.strip =~ /^Python #{py_version}(\.\d+)*/)'
+      then:
+      - throw: "Python must be in version '#{py_version}'"
+      else:
+      - print: "Python '#{py_version}' OK"
+    else:
+    - print: "Python version not checked"
+
+- target:      py_check
+  depends:     py_version
+  description: Check Python script syntax
+  script:
+  - python.pylint:
+      src:     :py_chk_src
+      files:   :py_chk_files
+      path:    :py_chk_path
+      config:  :py_chk_cfg
+      lenient: :py_chk_len
+      options: :py_chk_opt
+
+- target:      py_test
+  description: Run unit tests
+  script:
+  - python.test: "#{py_tst}/#{py_tst_inc}"
+
+- target:      py_doc
+  description: Generate doc for Python source code
+  script:
+  - rmrf:  :py_doc_dir
+  - mkdir: :py_doc_dir
+  - python.epydoc:
+      src:     :py_doc_src
+      dest:    :py_doc_dir
+      options: :py_doc_opt
+
+- target:      py_cover
+  description: Generate coverage report on Python code. coverage.py must have
+               been installed (http://nedbatchelder.com/code/coverage/).
+  script:
+  - rmrf:  :py_cov_dir
+  - mkdir: :py_cov_dir
+  - python.coverage:
+      src:  :py_src
+      test: "#{py_tst}/test_*.py"
+      dir:  :py_tst
+      data: "#{py_build_dir}/.coverage"
+
+- target:      py_run
+  description: Run Python script
+  script:
+  - python.python: :py_main
+
+- target:      py_clean
+  description: Clean generated files
+  script:
+  - rmdir: :py_clean_dirs
+  - rm:    :py_clean_files
+