Changes after review

plaso/analysis/manager.py

@@ -103,7 +103,7 @@ def GetPlugins(cls):
     """Retrieves the registered analysis plugin classes.
 
     Yields:
-      tuple: contains:
+      tuple: containing:
 
         str: name of the plugin
         type: plugin class

plaso/cli/image_export_tool.py

@@ -349,7 +349,7 @@ def _GetSourceFileSystem(self, source_path_spec, resolver_context=None):
       resolver_context (dfvfs.Context): resolver context.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
 
         dfvfs.FileSystem: file system.
         dfvfs.PathSpec: mount point path specification that refers

plaso/cli/tool_options.py

@@ -231,7 +231,7 @@ def _GetParserPresetsInformation(self):
     """Retrieves the parser presets information.
 
     Returns:
-      list[tuple]: contains:
+      list[tuple]: containing:
 
         str: parser preset name
         str: parsers names corresponding to the preset

plaso/engine/tagging_file.py

@@ -45,7 +45,7 @@ def _ParseDefinitions(self, tagging_file_path):
       tagging_file_path (str): path to the tagging file.
 
     Yields:
-      tuple: contains:
+      tuple: containing:
 
         str: label name.
         list[efilter.query.Query]: efilter queries.

plaso/filters/filter_list.py

@@ -53,7 +53,8 @@ def _ParseEntry(self, entry):
     """Parses a single filter entry.
 
     Args:
-      entry: YAML string that defines a single object filter entry.
+      entry (dict[str, dict(str, object)]): dictionary containing one more
+        filter rules and associated metadata.
 
     Raises:
       WrongPlugin: if the entry cannot be parsed.

plaso/formatters/asl.py

@@ -50,9 +50,9 @@ def GetMessages(self, unused_formatter_mediator, event):
     """Determines the formatted message strings for an event object.
 
     Args:
-      unused_formatter_mediator (FormatterMediator): mediates the interactions between
-          formatters and other components, such as storage and Windows EventLog
-          resources.
+      unused_formatter_mediator (FormatterMediator): mediates the interactions
+          between formatters and other components, such as storage and Windows
+          EventLog resources.
       event (EventObject): event.
 
     Returns:

plaso/multi_processing/psort.py

@@ -68,7 +68,7 @@ def _GetEventIdentifiers(self, event):
       event (EventObject): event.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
 
         str: identifier of the event MACB group or None if the event cannot
             be grouped.
@@ -127,7 +127,7 @@ def PopEvent(self):
     """Pops an event from the heap.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
 
         str: identifier of the event MACB group or None if the event cannot
             be grouped.

plaso/parsers/docker.py

@@ -99,12 +99,13 @@ def _GetIdentifierFromPath(self, parser_mediator):
           and other components, such as storage and dfvfs.
 
     Returns:
-        str: container or graph identifier.
+      str: container or graph identifier.
     """
     file_entry = parser_mediator.GetFileEntry()
     path = file_entry.path_spec.location
     file_system = file_entry.GetFileSystem()
-    identifier = file_system.SplitPath(path)[-2]
+    path_segments = file_system.SplitPath(path)
+    identifier = path_segments[-2]
     return identifier
 
   def _ParseLayerConfigJSON(self, parser_mediator, file_object):

plaso/parsers/firefox_cache.py

@@ -199,7 +199,7 @@ def _GetFirefoxConfig(self, file_object, display_name):
       display_name (str): display name.
 
     Returns:
-      firefox__cache_config: namedtuple containing the block size and first
+      firefox_cache_config: namedtuple containing the block size and first
           record offset.
 
     Raises:
@@ -285,7 +285,7 @@ def _ReadCacheEntry(self, file_object, display_name, block_size):
       block_size (int): block size.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
         construct.Struct: cache record header structure.
         FirefoxCacheEventData: event data.
 

plaso/parsers/mac_appfirewall.py

@@ -97,7 +97,7 @@ def _GetTimeElementsTuple(self, structure):
           a line of a text file.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
         year (int): year.
         month (int): month, where 1 represents January.
         day_of_month (int): day of month, where 1 is the first day of the month.

plaso/parsers/mac_keychain.py

@@ -239,13 +239,13 @@ def _ReadEntryHeader(
 
     Returns:
       tuple: containing:
-        ssgp_hash: Hash of the encrypted data (passwd, cert, note).
+        ssgp_hash: hash of the encrypted data (passwd, cert, note).
         creation_time (dfdatetime.TimeElements): entry creation time or None.
-        last_modification_time ((dfdatetime.TimeElements): entry last
+        last_modification_time (dfdatetime.TimeElements): entry last
             modification time or None.
-        text_description: A brief description of the entry.
-        entry_name: Name of the entry
-        account_name: Name of the account.
+        text_description: brief description of the entry.
+        entry_name: name of the entry
+        account_name: name of the account.
     """
     # TODO: reduce number of seeks and/or offset calculations needed
     # for parsing.

plaso/parsers/mac_securityd.py

@@ -106,7 +106,7 @@ def _GetTimeElementsTuple(self, structure):
           a line of a text file.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
         year (int): year.
         month (int): month, where 1 represents January.
         day_of_month (int): day of month, where 1 is the first day of the month.

plaso/parsers/mac_wifi.py

@@ -173,7 +173,7 @@ def _GetTimeElementsTuple(self, key, structure):
           a line of a text file.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
         year (int): year.
         month (int): month, where 1 represents January.
         day_of_month (int): day of month, where 1 is the first day of the month.

plaso/parsers/manager.py

@@ -30,7 +30,7 @@ def _GetParserFilters(cls, parser_filter_expression):
           represents all parsers and plugins.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
 
         * dict[str, BaseParser]: included parsers and plugins by name.
         * dict[str, BaseParser]: excluded parsers and plugins by name.
@@ -211,7 +211,7 @@ def GetFormatsWithSignatures(cls, parser_filter_expression=None):
           where None represents all parsers and plugins.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
 
       * FormatSpecificationStore: format specifications with signaures.
       * list[str[: remaining parser names that do not have a format
@@ -364,7 +364,7 @@ def GetParsers(cls, parser_filter_expression=None):
           where None represents all parsers and plugins.
 
     Yields:
-      tuple: contains:
+      tuple: containing:
 
       * str: name of the parser:
       * type: parser class (subclass of BaseParser).

plaso/parsers/sqlite.py

@@ -326,7 +326,7 @@ def _OpenDatabaseWithWAL(
       filename (str): name of the database file entry.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
 
         SQLiteDatabase: a database object with WAL file committed or None
         dfvfs.FileEntry: a file entry object of WAL file or None
@@ -370,7 +370,11 @@ def _OpenDatabaseWithWAL(
 
   @classmethod
   def GetFormatSpecification(cls):
-    """FormatSpecification: format specification."""
+    """Retrieves the format specification.
+
+    Returns:
+      FormatSpecification: format specification.
+    """
     format_specification = specification.FormatSpecification(cls.NAME)
     format_specification.AddNewSignature(b'SQLite format 3', offset=0)
     return format_specification

plaso/parsers/symantec.py

@@ -189,7 +189,7 @@ def _GetTimeElementsTuple(self, timestamp):
       timestamp (str): hexadecimal encoded date and time values.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
         year (int): year.
         month (int): month, where 1 represents January.
         day_of_month (int): day of month, where 1 is the first day of the month.

plaso/parsers/utmp.py

@@ -65,7 +65,7 @@ def _ReadEntry(self, parser_mediator, file_object, file_offset):
           the file-like object.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
 
         int: timestamp, which contains the number of microseconds
             since January 1, 1970, 00:00:00 UTC.

plaso/parsers/utmpx.py

@@ -63,7 +63,7 @@ def _ReadEntry(self, parser_mediator, file_object, file_offset):
           the file-like object.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
 
         int: timestamp, which contains the number of microseconds
             since January 1, 1970, 00:00:00 UTC.

plaso/parsers/winreg_plugins/bagmru.py

@@ -109,7 +109,7 @@ def _ParseMRUListExValue(self, parser_mediator, registry_key):
            the MRUListEx value.
 
     Yields:
-      tuple: contains:
+      tuple: containing:
 
         int: MRUListEx index, where 0 is the first index value.
         int: entry number.

plaso/parsers/winreg_plugins/task_scheduler.py

@@ -57,7 +57,7 @@ def _GetIdValue(self, registry_key):
       registry_key (dfwinreg.WinRegistryKey): Windows Registry key.
 
     Yields:
-      tuple: contains:
+      tuple: containing:
 
         dfwinreg.WinRegistryKey: Windows Registry key.
         dfwinreg.WinRegistryValue: Windows Registry value.

plaso/parsers/xchatlog.py

@@ -160,7 +160,7 @@ def _GetTimeElementsTuple(self, structure):
           a line of a text file.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
         year (int): year.
         month (int): month, where 1 represents January.
         day_of_month (int): day of month, where 1 is the first day of the month.

plaso/parsers/xchatscrollback.py

@@ -120,7 +120,7 @@ def _StripThenGetNicknameAndText(self, text):
       text (str): text obtained from the log record.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
 
         nickname (str): nickname.
         text (str): text sent by nickname or service messages.

plaso/storage/event_heaps.py

@@ -112,7 +112,7 @@ def PopEvent(self):
     """Pops an event from the heap.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
 
         int: event timestamp or None if the heap is empty
         bytes: serialized event or None if the heap is empty

tests/parsers/sqlite_plugins/test_lib.py

@@ -27,7 +27,7 @@ def _OpenDatabaseFile(self, path_segments, wal_path=None):
       wal_path (Optional[str]): path to the SQLite WAL file.
 
     Returns:
-      tuple: contains:
+      tuple: containing:
           file_entry (dfvfs.FileEntry): file entry of the SQLite database file.
           SQLiteDatabase: SQLite database file.
     """