typing: add typing to dogshell (#919)

Author: KowalskiThomas

datadog/dogshell/__init__.py

@@ -31,6 +31,7 @@
 
 
 def main():
+    # type: () -> None
     if sys.argv[0].endswith("dog"):
         warnings.warn("dog is pending deprecation. Please use dogshell instead.", PendingDeprecationWarning)
 

datadog/dogshell/comment.py

@@ -2,6 +2,7 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2015-Present Datadog, Inc
 # stdlib
+import argparse
 import json
 import sys
 
@@ -13,6 +14,7 @@
 class CommentClient(object):
     @classmethod
     def setup_parser(cls, subparsers):
+        # type: (argparse._SubParsersAction[argparse.ArgumentParser]) -> None
         parser = subparsers.add_parser("comment", help="Post, update, and delete comments.")
 
         verb_parsers = parser.add_subparsers(title="Verbs", dest="verb")
@@ -41,6 +43,7 @@ def setup_parser(cls, subparsers):
 
     @classmethod
     def _post(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         handle = args.handle
         comment = args.comment
@@ -70,6 +73,7 @@ def _post(cls, args):
 
     @classmethod
     def _update(cls, args):
+        # type: (argparse.Namespace) -> None
         handle = args.handle
         comment = args.comment
         id = args.comment_id
@@ -99,6 +103,7 @@ def _update(cls, args):
 
     @classmethod
     def _reply(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         handle = args.handle
         comment = args.comment
@@ -129,6 +134,7 @@ def _reply(cls, args):
 
     @classmethod
     def _show(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         id = args.comment_id
         format = args.format

datadog/dogshell/common.py

@@ -5,12 +5,14 @@
 from __future__ import print_function
 import os
 import sys
+from typing import Any, Dict, Optional
 
 # datadog
 from datadog.util.compat import is_p3k, configparser, IterableUserDict, get_input
 
 
 def print_err(msg):
+    # type: (str) -> None
     if is_p3k():
         print(msg + "\n", file=sys.stderr)
     else:
@@ -19,6 +21,7 @@ def print_err(msg):
 
 
 def report_errors(res):
+    # type: (Dict[str, Any]) -> bool
     if "errors" in res:
         errors = res["errors"]
         if isinstance(errors, list):
@@ -31,6 +34,7 @@ def report_errors(res):
 
 
 def report_warnings(res):
+    # type: (Dict[str, Any]) -> bool
     if "warnings" in res:
         warnings = res["warnings"]
         if isinstance(warnings, list):
@@ -44,6 +48,7 @@ def report_warnings(res):
 
 class DogshellConfig(IterableUserDict):
     def load(self, config_file, api_key, app_key, api_host):
+        # type: (str, Optional[str], Optional[str], Optional[str]) -> None
         config = configparser.ConfigParser()
 
         if api_host is not None:

datadog/dogshell/dashboard.py

@@ -7,6 +7,7 @@
 
 # 3p
 import argparse
+from typing import Any
 
 # datadog
 from datadog import api
@@ -17,6 +18,7 @@
 class DashboardClient(object):
     @classmethod
     def setup_parser(cls, subparsers):
+        # type: (argparse._SubParsersAction[argparse.ArgumentParser]) -> None
         parser = subparsers.add_parser("dashboard", help="Create, edit, and delete dashboards")
 
         verb_parsers = parser.add_subparsers(title="Verbs", dest="verb")
@@ -89,6 +91,7 @@ def setup_parser(cls, subparsers):
 
     @classmethod
     def _post(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         widgets = args.widgets
@@ -118,6 +121,7 @@ def _post(cls, args):
 
     @classmethod
     def _update(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         widgets = args.widgets
@@ -147,6 +151,7 @@ def _update(cls, args):
 
     @classmethod
     def _show(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         res = api.Dashboard.get(args.dashboard_id)
@@ -160,6 +165,7 @@ def _show(cls, args):
 
     @classmethod
     def _delete(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         res = api.Dashboard.delete(args.dashboard_id)
         if res is not None:
@@ -168,6 +174,7 @@ def _delete(cls, args):
 
 
 def _json_string(str):
+    # type: (str) -> Any
     try:
         return json.loads(str)
     except Exception:

datadog/dogshell/dashboard_list.py

@@ -2,6 +2,7 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2015-Present Datadog, Inc
 # stdlib
+import argparse
 import json
 
 # 3p
@@ -15,6 +16,7 @@
 class DashboardListClient(object):
     @classmethod
     def setup_parser(cls, subparsers):
+        # type: (argparse._SubParsersAction[argparse.ArgumentParser]) -> None
         parser = subparsers.add_parser("dashboard_list", help="Create, edit, and delete dashboard lists")
         verb_parsers = parser.add_subparsers(title="Verbs", dest="verb")
         verb_parsers.required = True
@@ -139,6 +141,7 @@ def setup_parser(cls, subparsers):
 
     @classmethod
     def _post(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         name = args.name
@@ -154,6 +157,7 @@ def _post(cls, args):
 
     @classmethod
     def _update(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id
@@ -170,6 +174,7 @@ def _update(cls, args):
 
     @classmethod
     def _show(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id
@@ -185,6 +190,7 @@ def _show(cls, args):
 
     @classmethod
     def _show_all(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
 
@@ -199,6 +205,7 @@ def _show_all(cls, args):
 
     @classmethod
     def _delete(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id
@@ -214,6 +221,7 @@ def _delete(cls, args):
 
     @classmethod
     def _show_dashboards(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id
@@ -229,6 +237,7 @@ def _show_dashboards(cls, args):
 
     @classmethod
     def _show_dashboards_v2(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id
@@ -244,6 +253,7 @@ def _show_dashboards_v2(cls, args):
 
     @classmethod
     def _add_dashboards(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id
@@ -260,6 +270,7 @@ def _add_dashboards(cls, args):
 
     @classmethod
     def _add_dashboards_v2(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id
@@ -276,6 +287,7 @@ def _add_dashboards_v2(cls, args):
 
     @classmethod
     def _update_dashboards(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id
@@ -292,6 +304,7 @@ def _update_dashboards(cls, args):
 
     @classmethod
     def _update_dashboards_v2(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id
@@ -308,6 +321,7 @@ def _update_dashboards_v2(cls, args):
 
     @classmethod
     def _delete_dashboards(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id
@@ -324,6 +338,7 @@ def _delete_dashboards(cls, args):
 
     @classmethod
     def _delete_dashboards_v2(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         dashboard_list_id = args.dashboard_list_id

datadog/dogshell/downtime.py

@@ -2,6 +2,7 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2015-Present Datadog, Inc
 # stdlib
+import argparse
 import json
 
 # 3p
@@ -15,6 +16,7 @@
 class DowntimeClient(object):
     @classmethod
     def setup_parser(cls, subparsers):
+        # type: (argparse._SubParsersAction[argparse.ArgumentParser]) -> None
         parser = subparsers.add_parser("downtime", help="Create, edit, and delete downtimes")
         parser.add_argument(
             "--string_ids",
@@ -65,6 +67,7 @@ def setup_parser(cls, subparsers):
 
     @classmethod
     def _schedule_downtime(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         res = api.Downtime.create(scope=args.scope, start=args.start, end=args.end, message=args.message)
@@ -77,6 +80,7 @@ def _schedule_downtime(cls, args):
 
     @classmethod
     def _update_downtime(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         res = api.Downtime.update(
@@ -91,6 +95,7 @@ def _update_downtime(cls, args):
 
     @classmethod
     def _cancel_downtime(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         res = api.Downtime.delete(args.downtime_id)
         if res is not None:
@@ -99,6 +104,7 @@ def _cancel_downtime(cls, args):
 
     @classmethod
     def _show_downtime(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         res = api.Downtime.get(args.downtime_id)
@@ -111,6 +117,7 @@ def _show_downtime(cls, args):
 
     @classmethod
     def _show_all_downtime(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         res = api.Downtime.get_all(current_only=args.current_only)
@@ -123,6 +130,7 @@ def _show_all_downtime(cls, args):
 
     @classmethod
     def _cancel_downtime_by_scope(cls, args):
+        # type: (argparse.Namespace) -> None
         api._timeout = args.timeout
         format = args.format
         res = api.Downtime.cancel_downtime_by_scope(scope=args.scope)