refactor: Code cleanup and linting

.flake8

@@ -1,4 +1,6 @@
 [flake8]
-ignore = E501, F821
+ignore = E501, F821, W504, W605, E303
 show-source = True
-
+count = True
+statistics = True
+max-line-length=127

.github/workflows/ci-pull-request.yml

@@ -42,10 +42,9 @@ jobs:
       run: poetry install
 
     - name: Lint
-      continue-on-error: true
       run: |
         # stop the build if there are Python syntax errors or undefined names
-        poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        poetry run flake8
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
 

doc/conf.py

@@ -18,8 +18,8 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
 
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -30,7 +30,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.linkcode' ]
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.linkcode']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -76,7 +76,6 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
-
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -95,13 +94,11 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'python-sdc-clientdoc'
 
-
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
@@ -130,7 +127,6 @@
      u'Sysdig Inc.', 'manual'),
 ]
 
-
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
@@ -140,7 +136,6 @@
      [author], 1)
 ]
 
-
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
@@ -159,13 +154,12 @@ def find_line():
         for part in info['fullname'].split('.'):
             obj = getattr(obj, part)
         import inspect
-        fn = inspect.getsourcefile(obj)
         source, lineno = inspect.findsource(obj)
         return lineno + 1
 
     if domain != 'py' or not info['module']:
         return None
-    #tag = 'master' if 'dev' in release else ('v' + release)
+    # tag = 'master' if 'dev' in release else ('v' + release)
     url = "https://github.com/draios/python-sdc-client/blob/master/sdcclient/_client.py"
     try:
         return url + '#L%d' % find_line()

examples/dashboard_backup_v1_restore_v2.py

@@ -12,12 +12,8 @@
 # Parse arguments
 #
 if len(sys.argv) != 5:
-    print((
-            'usage: %s <sysdig-v1-url> <sysdig-v1-token> <sysdig-v2-url> <sysdig-v2-token>'
-            % sys.argv[0]))
-    print(
-        'You can find your token at https://app.sysdigcloud.com/#/settings/user'
-    )
+    print(f'usage: {sys.argv[0]} <sysdig-v1-url> <sysdig-v1-token> <sysdig-v2-url> <sysdig-v2-token>')
+    print('You can find your token at https://app.sysdigcloud.com/#/settings/user')
     sys.exit(1)
 
 sdc_v1_url = sys.argv[1]

examples/delete_event.py

@@ -6,12 +6,12 @@
 import getopt
 import sys
 
-from sdcclient import SdcClient, SdMonitorClient
+from sdcclient import SdMonitorClient
+
 
 #
 # Parse arguments
 #
-from sdcclient.monitor import EventsClientV2
 
 
 def usage():

examples/get_data_simple.py

@@ -92,9 +92,9 @@
     #
     # Print table headers
     #
-    dataToPrint = ' '.join([str(x['id']).ljust(colLen) if len(str(x['id'])) < colLen else str(x['id'])[
-                                                                                          :(colLen - 3)].ljust(
-        colLen - 3) + '...' for x in metrics])
+    dataToPrint = ' '.join(
+        [str(x['id']).ljust(colLen) if len(str(x['id'])) < colLen else str(x['id'])[:(colLen - 3)].ljust(
+            colLen - 3) + '...' for x in metrics])
     print(('%s %s' % ('timestamp'.ljust(colLen), dataToPrint) if sampling > 0 else dataToPrint))
     print('')
 

examples/get_secure_policy_events_old.py

@@ -14,18 +14,18 @@
 # UNSUPPORTED: This script is unsupported as it is only an example from an old API version.
 # ===========================================================================================
 
-import os
-import sys
+import getopt
 import json
 import operator
 import re
-import getopt
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+import sys
+
 from sdcclient.secure import PolicyEventsClientOld
 
 
 def usage():
-    print('usage: %s [-s|--summarize] [-l|--limit <limit>] <sysdig-token> [<duration sec>|<from sec> <to sec>]' % sys.argv[0])
+    print('usage: %s [-s|--summarize] [-l|--limit <limit>] <sysdig-token> [<duration sec>|<from sec> <to sec>]' %
+          sys.argv[0])
     print('-s|--summarize: group policy events by sanitized output and print by frequency')
     print('-l|--limit: with -s, only print the first <limit> outputs')
     print('You can find your token at https://secure.sysdig.com/#/settings/user')

examples/list_access_keys.py

@@ -4,9 +4,8 @@
 # have Admin rights.
 #
 
-import os
 import sys
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+
 from sdcclient import SdcClient
 
 #

examples/restore_alerts.py

@@ -87,5 +87,5 @@
             print(res)
             sys.exit(1)
 
-print(('All Alerts in ' + alerts_dump_file + ' restored successfully ('
-       + str(created_count) + ' created, ' + str(updated_count) + ' updated)'))
+print(f'All Alerts in {alerts_dump_file} restored successfully '
+      f'({str(created_count)} created, {str(updated_count)} updated)')

sdcclient/__init__.py

@@ -1,9 +1,11 @@
-from sdcclient._monitor import SdcClient
-from sdcclient._monitor import SdMonitorClient
+import sdcclient.monitor as monitor
+import sdcclient.secure as secure
+from sdcclient._monitor import SdMonitorClient, SdcClient
 from sdcclient._monitor_v1 import SdMonitorClientV1
+from sdcclient._scanning import SdScanningClient
 from sdcclient._secure import SdSecureClient
 from sdcclient._secure_v1 import SdSecureClientV1
-from sdcclient._scanning import SdScanningClient
 from sdcclient.ibm_auth_helper import IbmAuthHelper
-import sdcclient.secure
-import sdcclient.monitor
+
+__all__ = ["SdMonitorClient", "SdcClient", "SdMonitorClientV1", "SdScanningClient", "SdSecureClient",
+           "SdSecureClientV1", "IbmAuthHelper", "monitor", "secure"]