Chore/cleanups (#114)

* Remove inaccurate unneeded doc

* Dont override existing var

* Conform prefix like other existing var

* Missing period

* Unneeded u's

* missing space

* Remove unused var

* Appease possible None

* Flake8 no defining lambdas

* Rm unused vars

* use defs instead of lambdas when defining

* Remove unused vars

* Imply negation is test name / rm dup test name

* Remove unused var

* Spelling

* More flakey fixes

* Remove unused stuff

* Fix doc str var

* other cleanups

Author: Juliya Smith

src/code42cli/cmds/alert_rules.py

@@ -113,8 +113,9 @@ def bulk(state):
 @sdk_options
 def add(state, csv_rows):
     sdk = state.sdk
-    row_handler = lambda rule_id, username: _add_user(sdk, rule_id, username)
-    run_bulk_process(row_handler, csv_rows, progress_label="Adding users to alert-rules:")
+    def handle_row(rule_id, username):
+        _add_user(sdk, rule_id, username)
+    run_bulk_process(handle_row, csv_rows, progress_label="Adding users to alert-rules:")
 
 
 @bulk.command(
@@ -126,8 +127,9 @@ def add(state, csv_rows):
 @sdk_options
 def remove(state, csv_rows):
     sdk = state.sdk
-    row_handler = lambda rule_id, username: _remove_user(sdk, rule_id, username)
-    run_bulk_process(row_handler, csv_rows, progress_label="Removing users from alert-rules:")
+    def handle_row(rule_id, username):
+        _remove_user(sdk, rule_id, username)
+    run_bulk_process(handle_row, csv_rows, progress_label="Removing users from alert-rules:")
 
 
 def _add_user(sdk, rule_id, username):
@@ -136,7 +138,7 @@ def _add_user(sdk, rule_id, username):
     try:
         if rules:
             sdk.alerts.rules.add_user(rule_id, user_id)
-    except Py42InternalServerError as e:
+    except Py42InternalServerError:
         _check_if_system_rule(rules)
         raise
 
@@ -147,7 +149,7 @@ def _remove_user(sdk, rule_id, username):
     try:
         if rules:
             sdk.alerts.rules.remove_user(rule_id, user_id)
-    except Py42InternalServerError as e:
+    except Py42InternalServerError:
         _check_if_system_rule(rules)
         raise
 

src/code42cli/cmds/departing_employee.py

@@ -63,11 +63,12 @@ def bulk(state):
 @sdk_options
 def add(state, csv_rows):
     sdk = state.sdk
-    row_handler = lambda username, cloud_alias, departure_date, notes: _add_departing_employee(
-        sdk, username, cloud_alias, departure_date, notes
-    )
+    def handle_row(username, cloud_alias, departure_date, notes):
+        _add_departing_employee(
+            sdk, username, cloud_alias, departure_date, notes
+        )
     run_bulk_process(
-        row_handler, csv_rows, progress_label="Adding users to departing employee detection list:"
+        handle_row, csv_rows, progress_label="Adding users to departing employee detection list:"
     )
 
 
@@ -79,9 +80,10 @@ def add(state, csv_rows):
 @sdk_options
 def remove(state, file_rows):
     sdk = state.sdk
-    row_handler = lambda username: _remove_departing_employee(sdk, username)
+    def handle_row(username):
+        _remove_departing_employee(sdk, username)
     run_bulk_process(
-        row_handler,
+        handle_row,
         file_rows,
         progress_label="Removing users from departing employee detection list:",
     )

src/code42cli/cmds/detectionlists/__init__.py

@@ -7,8 +7,7 @@ def update_user(sdk, username, cloud_alias=None, risk_tag=None, notes=None):
 
     Args:
         sdk (py42.sdk.SDKClient): py42 sdk.
-        user_id (str or unicode): The ID of the user to update. This is their `userUid` found from 
-            `sdk.users.get_by_username()`.
+        username (str or unicode): The username of the user to update.
         cloud_alias (str or unicode): A cloud alias to add to the user.
         risk_tag (iter[str or unicode]): A list of risk tags associated with user.
         notes (str or unicode): Notes about the user.

src/code42cli/cmds/high_risk_employee.py

@@ -102,11 +102,12 @@ def bulk(state):
 @sdk_options
 def add(state, csv_rows):
     sdk = state.sdk
-    row_handler = lambda username, cloud_alias, risk_tag, notes: _add_high_risk_employee(
-        sdk, username, cloud_alias, risk_tag, notes
-    )
+    def handle_row(username, cloud_alias, risk_tag, notes):
+        _add_high_risk_employee(
+            sdk, username, cloud_alias, risk_tag, notes
+        )
     run_bulk_process(
-        row_handler, csv_rows, progress_label="Adding users to high risk employee detection list:"
+        handle_row, csv_rows, progress_label="Adding users to high risk employee detection list:"
     )
 
 
@@ -118,9 +119,10 @@ def add(state, csv_rows):
 @sdk_options
 def remove(state, file_rows):
     sdk = state.sdk
-    row_handler = lambda username: _remove_high_risk_employee(sdk, username)
+    def handle_row(username):
+        _remove_high_risk_employee(sdk, username)
     run_bulk_process(
-        row_handler,
+        handle_row,
         file_rows,
         progress_label="Removing users from high risk employee detection list:",
     )
@@ -135,9 +137,10 @@ def remove(state, file_rows):
 @sdk_options
 def add_risk_tags(state, csv_rows):
     sdk = state.sdk
-    row_handler = lambda username, tag: _add_risk_tags(sdk, username, tag)
+    def handle_row(username, tag):
+        _add_risk_tags(sdk, username, tag)
     run_bulk_process(
-        row_handler, csv_rows, progress_label="Adding risk tags to users:",
+        handle_row, csv_rows, progress_label="Adding risk tags to users:",
     )
 
 
@@ -150,9 +153,10 @@ def add_risk_tags(state, csv_rows):
 @sdk_options
 def remove_risk_tags(state, csv_rows):
     sdk = state.sdk
-    row_handler = lambda username, tag: _remove_risk_tags(sdk, username, tag)
+    def handle_row(username, tag):
+        _remove_risk_tags(sdk, username, tag)
     run_bulk_process(
-        row_handler, csv_rows, progress_label="Removing risk tags from users:",
+        handle_row, csv_rows, progress_label="Removing risk tags from users:",
     )
 
 
@@ -169,12 +173,5 @@ def _add_high_risk_employee(sdk, username, cloud_alias, risk_tag, notes):
 
 
 def _remove_high_risk_employee(sdk, username):
-    """Removes an employee from the high risk employee detection list.
-
-    Args:
-        sdk (py42.sdk.SDKClient): py42.
-        profile (C42Profile): Your code42 profile.
-        username (str): The username of the employee to remove.
-    """
     user_id = get_user_id(sdk, username)
     sdk.detectionlists.high_risk_employee.remove(user_id)

src/code42cli/cmds/legal_hold.py

@@ -140,8 +140,9 @@ def bulk(state):
 @sdk_options
 def add(state, csv_rows):
     sdk = state.sdk
-    row_handler = lambda matter_id, username: _add_user_to_legal_hold(sdk, matter_id, username)
-    run_bulk_process(row_handler, csv_rows, progress_label="Adding users to legal hold:")
+    def handle_row(matter_id, username):
+        _add_user_to_legal_hold(sdk, matter_id, username)
+    run_bulk_process(handle_row, csv_rows, progress_label="Adding users to legal hold:")
 
 
 @bulk.command(
@@ -153,8 +154,9 @@ def add(state, csv_rows):
 @sdk_options
 def remove(state, csv_rows):
     sdk = state.sdk
-    row_handler = lambda matter_id, username: _remove_user_from_legal_hold(sdk, matter_id, username)
-    run_bulk_process(row_handler, csv_rows, progress_label="Removing users from legal hold:")
+    def handle_row(matter_id, username):
+        _remove_user_from_legal_hold(sdk, matter_id, username)
+    run_bulk_process(handle_row, csv_rows, progress_label="Removing users from legal hold:")
 
 
 def _add_user_to_legal_hold(sdk, matter_id, username):

src/code42cli/cmds/profile.py

@@ -73,10 +73,10 @@ def create(name, server, username, disable_ssl_errors=False):
 @disable_ssl_option
 def update(name=None, server=None, username=None, disable_ssl_errors=None):
     """Update an existing profile."""
-    profile = cliprofile.get_profile(name)
-    cliprofile.update_profile(profile.name, server, username, disable_ssl_errors)
-    _prompt_for_allow_password_set(profile.name)
-    echo("Profile '{}' has been updated.".format(profile.name))
+    c42profile = cliprofile.get_profile(name)
+    cliprofile.update_profile(c42profile.name, server, username, disable_ssl_errors)
+    _prompt_for_allow_password_set(c42profile.name)
+    echo("Profile '{}' has been updated.".format(c42profile.name))
 
 
 @profile.command()
@@ -92,8 +92,8 @@ def _list():
     profiles = cliprofile.get_all_profiles()
     if not profiles:
         raise Code42CLIError("No existing profile.", help=CREATE_PROFILE_HELP)
-    for profile in profiles:
-        echo(str(profile))
+    for c42profile in profiles:
+        echo(str(c42profile))
 
 
 @profile.command()
@@ -125,11 +125,11 @@ def delete_all():
         message = (
             "\nAre you sure you want to delete the following profiles?\n\t{}"
             "\n\nThis will also delete any stored passwords and checkpoints. (y/n): "
-        ).format("\n\t".join([profile.name for profile in existing_profiles]))
+        ).format("\n\t".join([c42profile.name for c42profile in existing_profiles]))
         if does_user_agree(message):
-            for profile in existing_profiles:
-                cliprofile.delete_profile(profile.name)
-                echo("Profile '{}' has been deleted.".format(profile.name))
+            for profile_obj in existing_profiles:
+                cliprofile.delete_profile(profile_obj.name)
+                echo("Profile '{}' has been deleted.".format(profile_obj.name))
     else:
         echo("\nNo profiles exist. Nothing to delete.")
 

src/code42cli/cmds/search/cursor_store.py

@@ -55,7 +55,7 @@ def clean(self):
             self.delete(cursor.name)
 
     def get_all_cursors(self):
-        """Returns a list of all cursors stored in this directory (which istypically scoped to a profile)."""
+        """Returns a list of all cursors stored in this directory (which is typically scoped to a profile)."""
         dir_contents = os.listdir(self._dir_path)
         return [Cursor(f) for f in dir_contents if self._is_file(f)]
 
@@ -65,13 +65,13 @@ def _is_file(self, node_name):
 
 class FileEventCursorStore(BaseCursorStore):
     def __init__(self, profile_name):
-        dir_path = get_user_project_path(u"file_event_checkpoints", profile_name)
+        dir_path = get_user_project_path("file_event_checkpoints", profile_name)
         super(FileEventCursorStore, self).__init__(dir_path)
 
 
 class AlertCursorStore(BaseCursorStore):
     def __init__(self, profile_name):
-        dir_path = get_user_project_path(u"alert_checkpoints", profile_name)
+        dir_path = get_user_project_path("alert_checkpoints", profile_name)
         super(AlertCursorStore, self).__init__(dir_path)
 
 

src/code42cli/cmds/search/extraction.py

@@ -60,10 +60,12 @@ def handle_response(response):
             except Exception as ex:
                 handlers.handle_error(ex)
         handlers.TOTAL_EVENTS += len(events)
+        event = None
         for event in events:
             output_logger.info(event)
-        last_event_timestamp = extractor._get_timestamp_from_item(event)
-        handlers.record_cursor_position(last_event_timestamp)
+        if event:
+            last_event_timestamp = extractor._get_timestamp_from_item(event)
+            handlers.record_cursor_position(last_event_timestamp)
 
     handlers.handle_response = handle_response
     return handlers
@@ -75,6 +77,8 @@ def create_time_range_filter(filter_cls, begin_date=None, end_date=None):
         `None` if both begin_date and end_date args are `None`.
         
         Args:
+            filter_cls: The class of filter to create. (must be a subclass of 
+              :class:`py42.sdk.queries.query_filter.QueryFilterTimestampField`)
             begin_date: The begin date for the range.
             end_date: The end date for the range.
     """

src/code42cli/cmds/search/options.py

@@ -3,7 +3,6 @@
 
 import click
 
-from code42cli.cmds.search.enums import ServerProtocol
 from code42cli.date_helper import parse_min_timestamp, parse_max_timestamp
 from code42cli.logger import get_main_cli_logger
 from code42cli.options import incompatible_with

src/code42cli/cmds/securitydata.py

@@ -129,7 +129,7 @@ def _get_saved_search_query(ctx, param, arg):
 
 saved_search_option = click.option(
     "--saved-search",
-    help="Get events from a saved search filter with the given ID",
+    help="Get events from a saved search filter with the given ID.",
     callback=_get_saved_search_query,
     cls=incompatible_with("advanced_query"),
 )