style: format all py code with ruff

Author: tembleking

docs/conf.py

@@ -20,7 +20,7 @@
 import sys
 from datetime import datetime
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration ------------------------------------------------
 
@@ -31,35 +31,43 @@
 # 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.autosectionlabel', 'sphinx.ext.graphviz',
-              'sphinx.ext.inheritance_diagram', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary',
-              'sphinx.ext.githubpages', 'sphinx.ext.napoleon', 'sphinx_rtd_theme']
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.inheritance_diagram",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
+    "sphinx_rtd_theme",
+]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'Sysdig SDK for Python'
-copyright = f'2016-{datetime.now().year}, Sysdig Inc.'
-author = u'Sysdig Inc.'
+project = "Sysdig SDK for Python"
+copyright = f"2016-{datetime.now().year}, Sysdig Inc."
+author = "Sysdig Inc."
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u''
+version = ""
 # The full version, including alpha/beta/rc tags.
-release = u''
+release = ""
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -71,10 +79,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -84,7 +92,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -100,23 +108,20 @@
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'python-sdc-clientdoc'
+htmlhelp_basename = "python-sdc-clientdoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -126,17 +131,21 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'python-sdc-client.tex', u'python-sdc-client Documentation',
-     u'Sysdig Inc.', 'manual'),
+    (
+        master_doc,
+        "python-sdc-client.tex",
+        "python-sdc-client Documentation",
+        "Sysdig Inc.",
+        "manual",
+    ),
 ]
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'python-sdc-client', u'python-sdc-client Documentation',
-     [author], 1)
+    (master_doc, "python-sdc-client", "python-sdc-client Documentation", [author], 1)
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -145,9 +154,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'python-sdc-client', u'python-sdc-client Documentation',
-     author, 'python-sdc-client', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "python-sdc-client",
+        "python-sdc-client Documentation",
+        author,
+        "python-sdc-client",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Napoleon settings

examples/add_notification_email.py

@@ -11,8 +11,8 @@
 # Parse arguments
 #
 if len(sys.argv) != 3:
-    print(('usage: %s <sysdig-token> email' % sys.argv[0]))
-    print('You can find your token at https://app.sysdigcloud.com/#/settings/user')
+    print(("usage: %s <sysdig-token> email" % sys.argv[0]))
+    print("You can find your token at https://app.sysdigcloud.com/#/settings/user")
     sys.exit(1)
 
 sdc_token = sys.argv[1]
@@ -32,7 +32,7 @@
 # Return the result
 #
 if ok:
-    print('Recipient added successfully')
+    print("Recipient added successfully")
 else:
     print(res)
     sys.exit(1)

examples/add_policy.py

@@ -10,9 +10,9 @@
 
 
 def usage():
-    print(('usage: %s <sysdig-token>' % sys.argv[0]))
-    print('Reads policy json from standard input')
-    print('You can find your token at https://secure.sysdig.com/#/settings/user')
+    print(("usage: %s <sysdig-token>" % sys.argv[0]))
+    print("Reads policy json from standard input")
+    print("You can find your token at https://secure.sysdig.com/#/settings/user")
     sys.exit(1)
 
 
@@ -29,7 +29,7 @@ def usage():
 #
 # Instantiate the SDC client
 #
-sdclient = SdSecureClient(sdc_token, 'https://secure.sysdig.com')
+sdclient = SdSecureClient(sdc_token, "https://secure.sysdig.com")
 
 ok, res = sdclient.add_policy_json(policy_json)
 

examples/add_policy_v1.py

@@ -10,9 +10,9 @@
 
 
 def usage():
-    print(('usage: %s <sysdig-token>' % sys.argv[0]))
-    print('Reads policy json from standard input')
-    print('You can find your token at https://secure.sysdig.com/#/settings/user')
+    print(("usage: %s <sysdig-token>" % sys.argv[0]))
+    print("Reads policy json from standard input")
+    print("You can find your token at https://secure.sysdig.com/#/settings/user")
     sys.exit(1)
 
 
@@ -29,7 +29,7 @@ def usage():
 #
 # Instantiate the SDC client
 #
-sdclient = SdSecureClientV1(sdc_token, 'https://secure.sysdig.com')
+sdclient = SdSecureClientV1(sdc_token, "https://secure.sysdig.com")
 
 ok, res = sdclient.add_policy(policy_json)
 

examples/add_users_to_secure.py

@@ -20,38 +20,38 @@
 # Parse arguments
 #
 if len(sys.argv) != 2:
-    print(('usage: %s <sysdig-token>' % sys.argv[0]))
-    print('You can find your token at https://app.sysdigcloud.com/#/settings/user')
+    print(("usage: %s <sysdig-token>" % sys.argv[0]))
+    print("You can find your token at https://app.sysdigcloud.com/#/settings/user")
     sys.exit(1)
 
 sdc_token = sys.argv[1]
 
-SECURE_TEAM_NAME = 'Secure Operations'
+SECURE_TEAM_NAME = "Secure Operations"
 
 #
 # As of when this script was written, the Secure Operations team does
 # not have the concepts of RBAC roles like "Read User" vs. "Edit User".
 # Rather, all members of the Secure team have full visibility within
 # Secure, which is associated with ROLE_TEAM_EDIT.
 #
-SECURE_TEAM_ROLE = 'ROLE_TEAM_EDIT'
+SECURE_TEAM_ROLE = "ROLE_TEAM_EDIT"
 
 #
 # Instantiate the SDC client
 #
-sdclient = SdcClient(sdc_token, sdc_url='https://app.sysdigcloud.com')
+sdclient = SdcClient(sdc_token, sdc_url="https://app.sysdigcloud.com")
 
 ok, res = sdclient.list_memberships(SECURE_TEAM_NAME)
 
 if not ok:
-    print(('Unable to get memberships for ' + SECURE_TEAM_NAME + ' team: ', res))
+    print(("Unable to get memberships for " + SECURE_TEAM_NAME + " team: ", res))
     sys.exit(1)
 memberships = res
 
 ok, res = sdclient.get_users()
 
 if not ok:
-    print(('Unable to get users: ', res))
+    print(("Unable to get users: ", res))
     sys.exit(1)
 all_users = res
 
@@ -60,15 +60,15 @@
 # rather than ID, so convert the IDs.
 #
 for user in all_users:
-    if user['username'] in memberships:
-        print(('Will preserve existing membership for: ' + user['username']))
+    if user["username"] in memberships:
+        print(("Will preserve existing membership for: " + user["username"]))
     else:
-        print(('Will add new member: ' + user['username']))
-        memberships[user['username']] = SECURE_TEAM_ROLE
+        print(("Will add new member: " + user["username"]))
+        memberships[user["username"]] = SECURE_TEAM_ROLE
 
 ok, res = sdclient.save_memberships(SECURE_TEAM_NAME, memberships=memberships)
 if not ok:
-    print(('Could not edit team:', res, '. Exiting.'))
+    print(("Could not edit team:", res, ". Exiting."))
     sys.exit(1)
 else:
     print(('Finished syncing memberships of "' + SECURE_TEAM_NAME + '" team'))

examples/create_access_keys.py

@@ -12,36 +12,40 @@
 # Parse arguments
 #
 if len(sys.argv) != 2:
-    print('usage: %s <sysdig-token>' % sys.argv[0])
-    print('You can find your token at https://app.sysdigcloud.com/#/settings/user')
-    print('For this script to work, the user for the token must have Admin rights')
+    print("usage: %s <sysdig-token>" % sys.argv[0])
+    print("You can find your token at https://app.sysdigcloud.com/#/settings/user")
+    print("For this script to work, the user for the token must have Admin rights")
     sys.exit(1)
 
 sdc_token = sys.argv[1]
 
 # Maximum number of agents allowed to connect for this access key. Set to '' if not required
-agent_limit = ''
+agent_limit = ""
 # Number of agent licenses that are ALWAYS available to this access key. This directly counts against the maximum number of available licenses. Set to '' if not required.
-agent_reserved = ''
+agent_reserved = ""
 # Team ID to which to assign the access key. Team ID must be valid. Set to '' if not required.
-team_id = ''
+team_id = ""
 
 
 #
 # Instantiate the SDC client
 #
-sdclient = SdcClient(sdc_token, 'https://app.sysdigcloud.com')
+sdclient = SdcClient(sdc_token, "https://app.sysdigcloud.com")
 
 #
 # Get the configuration
 #
-ok, res = sdclient.create_access_key(
-    agent_limit,
-    agent_reserved,
-    team_id)
+ok, res = sdclient.create_access_key(agent_limit, agent_reserved, team_id)
 
 if ok:
-    print('Access Key: {}\nTeam ID: {}\nAgent Limit: {}\nAgent Reserved: {}\n==========='.format(res['customerAccessKey']['accessKey'], res['customerAccessKey']['teamId'], res['customerAccessKey']['limit'], res['customerAccessKey']['reservation']))
+    print(
+        "Access Key: {}\nTeam ID: {}\nAgent Limit: {}\nAgent Reserved: {}\n===========".format(
+            res["customerAccessKey"]["accessKey"],
+            res["customerAccessKey"]["teamId"],
+            res["customerAccessKey"]["limit"],
+            res["customerAccessKey"]["reservation"],
+        )
+    )
 else:
     print(res)
     sys.exit(1)

examples/create_alert.py

@@ -16,9 +16,9 @@
 # Parse arguments
 #
 def usage():
-    print(('usage: %s [-a|--alert <name>] <sysdig-token>' % sys.argv[0]))
-    print('-a|--alert: Set name of alert to create')
-    print('You can find your token at https://app.sysdigcloud.com/#/settings/user')
+    print(("usage: %s [-a|--alert <name>] <sysdig-token>" % sys.argv[0]))
+    print("-a|--alert: Set name of alert to create")
+    print("You can find your token at https://app.sysdigcloud.com/#/settings/user")
     sys.exit(1)
 
 
@@ -45,10 +45,14 @@ def usage():
 #
 # Find notification channels (you need IDs to create an alert).
 #
-notify_channels = [{'type': 'SLACK', 'channel': '#python-sdc-test-alert'},
-                   {'type': 'EMAIL', 'emailRecipients': ['[email protected]', '[email protected]']},
-                   {'type': 'SNS', 'snsTopicARNs': ['arn:aws:sns:us-east-1:273107874544:alarms-stg']}
-                   ]
+notify_channels = [
+    {"type": "SLACK", "channel": "#python-sdc-test-alert"},
+    {
+        "type": "EMAIL",
+        "emailRecipients": ["[email protected]", "[email protected]"],
+    },
+    {"type": "SNS", "snsTopicARNs": ["arn:aws:sns:us-east-1:273107874544:alarms-stg"]},
+]
 
 ok, res = sdclient.get_notification_ids(notify_channels)
 if not ok:
@@ -62,17 +66,21 @@ def usage():
 #
 ok, res = sdclient.create_alert(
     alert_name,  # Alert name.
-    'this alert was automatically created using the python Sysdig Cloud library',  # Alert description.
+    "this alert was automatically created using the python Sysdig Cloud library",  # Alert description.
     6,  # Syslog-encoded severity. 6 means 'info'.
     60,  # The alert will fire if the condition is met for at least 60 seconds.
-    'avg(cpu.used.percent) > 80',  # The condition.
-    ['host.mac', 'proc.name'],  # Segmentation. We want to check this metric for every process on every machine.
-    'ANY',
+    "avg(cpu.used.percent) > 80",  # The condition.
+    [
+        "host.mac",
+        "proc.name",
+    ],  # Segmentation. We want to check this metric for every process on every machine.
+    "ANY",
     # in case there is more than one tomcat process, this alert will fire when a single one of them crosses the 80% threshold.
     'proc.name = "tomcat"',
     # Filter. We want to receive a notification only if the name of the process meeting the condition is 'tomcat'.
     notification_channel_ids,
-    False)  # This alert will be disabled when it's created.
+    False,
+)  # This alert will be disabled when it's created.
 
 #
 # Validate a print the results.