Merge pull request #102 from RamanjaneyuluIdavalapati/master

status codes and README for sub commands #101, #82

Author: jaswanth098

.travis.yml

@@ -19,8 +19,8 @@ deploy:
   - basescript/utils.py
   - examples/adder.py
   - examples/helloworld.py
-  name: basescript-0.3.4
-  tag_name: 0.3.4
+  name: basescript-0.3.5
+  tag_name: 0.3.5
   true:
     repo: deep-compute/basescript
 - provider: pypi

README.md

@@ -148,6 +148,46 @@ https://docs.python.org/2/library/logging.html#logging-levels.
 `log` is a log object created using python's standard `logging` module. You can
 read more about it at https://docs.python.org/2/library/logging.html.
 
+#### Sub commands
+When we have multiple functionalities then there is a way to call or execute each functionality with different sub command.
+
+For example if we have add and subtract in the same script then we can call each functionality with different sub command.
+
+calc.py
+```python
+from basescript import BaseScript
+
+class Calc(BaseScript):
+    A = 10
+
+    def add(self):
+        print(self.A + self.args.b)
+
+    def sub(self):
+        print(self.A - self.args.b)
+
+    def define_subcommands(self, subcommands):
+        super(Calc, self).define_subcommands(subcommands)
+
+        add_cmd = subcommands.add_parser("add", help="Adds number")
+        add_cmd.set_defaults(func=self.add)
+        add_cmd.add_argument('--b', type=int, help="Number to add")
+
+        sub_cmd = subcommands.add_parser("sub", help="Subtracts number")
+        sub_cmd.set_defaults(func=self.sub)
+        sub_cmd.add_argument('--b', type=int, help="Number to subtract")
+
+if __name__ == '__main__':
+    Calc().start()
+```
+Run
+```bash
+$ python3 calc.py add --b 4
+14
+$ python3 calc.py sub --b 4
+6
+```
+
 ### Metric-Grouping
 When writing a `Metric` using `self.log`, you can specify `type=metric`. If this is done, a background thread will automatically group multiple metrics into one by averaging values (to prevent writing too many log lines).
 test.py

basescript/basescript.py

@@ -77,10 +77,9 @@ def start(self):
                 raise
         except KeyboardInterrupt:
             self.log.warning("exited via keyboard interrupt")
-        except:
-            self.log.exception("exited start function")
-            # set exit code so we know it did not end successfully
-            # TODO different exit codes based on signals ?
+        except Exception as e:
+            self.log.error("exited start function")
+            raise e
         finally:
             self._flush_metrics_q.put(None, block=True)
             self._flush_metrics_q.put(None, block=True, timeout=1)

setup.py

@@ -25,7 +25,7 @@ def get_long_description():
 
 long_description = get_long_description()
 
-version = "0.3.4"
+version = "0.3.5"
 setup(
     name="basescript",
     version=version,