chore: address lint problems

Author: jondricek

docs/conf.py

@@ -1,6 +1,9 @@
-# Configuration file for the Sphinx documentation builder.
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
+Configuration file for the Sphinx documentation builder.
+
+For the full list of built-in configuration values, see the documentation:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
 
 import os
 import sys

mitreattack/__init__.py

@@ -1,3 +1,11 @@
-from .attackToExcel import *
-from .collections import *
-from .navlayers import *
+# from .attackToExcel import *
+# from .collections import *
+# from .navlayers import *
+
+from . import attackToExcel, collections, navlayers
+
+__all__ = [
+    "attackToExcel",
+    "collections",
+    "navlayers",
+]

mitreattack/attackToExcel/stixToDf.py

@@ -842,15 +842,15 @@ def matricesToDf(src, domain):
         for column in matrix_grid:
             longest_column = max(len(column), longest_column)
         for column in matrix_grid:
-            for i in range((longest_column - len(column))):
+            for _ in range((longest_column - len(column))):
                 column.append("")
 
         for submatrix in sub_matrices_grid:
             mg = sub_matrices_grid[submatrix]
             for column in mg:
                 longest_column = max(len(column), longest_column)
             for column in mg:
-                for i in range((longest_column - len(column))):
+                for _ in range((longest_column - len(column))):
                     column.append("")
         # matrix is now squared
 

mitreattack/collections/__init__.py

@@ -1,2 +1,7 @@
-from .collection_to_index import *
-from .index_to_markdown import *
+from .collection_to_index import CollectionToIndex
+from .index_to_markdown import IndexToMarkdown
+
+__all__ = [
+    "CollectionToIndex",
+    "IndexToMarkdown",
+]

mitreattack/diffStix/changelog_helper.py

@@ -44,6 +44,7 @@ class AttackObjectVersion:
     minor: int
 
     def __repr__(self):
+        """Return a string representation of the ATT&CK object version."""
         return f"{self.major}.{self.minor}"
 
 
@@ -65,7 +66,7 @@ class DiffStix(object):
 
     def __init__(
         self,
-        domains: List[str] = ["enterprise-attack", "mobile-attack", "ics-attack"],
+        domains: Optional[List[str]] = None,
         layers: Optional[List[str]] = None,
         unchanged: bool = False,
         old: Optional[str] = "old",
@@ -101,6 +102,8 @@ def __init__(
         include_contributors : bool, optional
             Include contributor information for new contributors, by default False
         """
+        if domains is None:
+            domains = ["enterprise-attack", "mobile-attack", "ics-attack"]
         self.domains = domains
         self.layers = layers
         self.unchanged = unchanged
@@ -2024,7 +2027,7 @@ def get_parsed_args():
 
 
 def get_new_changelog_md(
-    domains: List[str] = ["enterprise-attack", "mobile-attack", "ics-attack"],
+    domains: Optional[List[str]] = None,
     layers: List[str] = layer_defaults,
     unchanged: bool = False,
     old: Optional[str] = None,
@@ -2080,6 +2083,8 @@ def get_new_changelog_md(
         A Markdown string representation of differences between two ATT&CK versions.
     """
     # the default loguru logger logs up to Debug by default
+    if domains is None:
+        domains = ["enterprise-attack", "mobile-attack", "ics-attack"]
     logger.remove()
     if verbose:
         logger.add(lambda msg: tqdm.write(msg, end=""), colorize=True)

mitreattack/navlayers/__init__.py

@@ -1,4 +1,97 @@
-from .core import *
-from .exporters import *
-from .generators import *
-from .manipulators import *
+from .core import (
+    UNSETVALUE,
+    BadInput,
+    BadType,
+    Filter,
+    Gradient,
+    Layer,
+    Layout,
+    LegendItem,
+    Link,
+    LinkDiv,
+    Metadata,
+    MetaDiv,
+    MissingParameters,
+    Technique,
+    UninitializedLayer,
+    UnknownLayerProperty,
+    UnknownTechniqueProperty,
+    Versions,
+    _LayerObj,
+    categoryChecker,
+    handle_object_placement,
+    handler,
+    loadChecker,
+    typeChecker,
+    typeCheckerArray,
+)
+from .exporters import (
+    ExcelTemplates,
+    MatrixGen,
+    SVGConfig,
+    SvgTemplates,
+    ToExcel,
+    ToSvg,
+)
+from .generators import (
+    OverviewLayerGenerator,
+    UsageLayerGenerator,
+    build_data_strings,
+    construct_relationship_mapping,
+    get_attack_id,
+    remove_revoked_depreciated,
+)
+from .manipulators import (
+    BadLambda,
+    InvalidFormat,
+    LayerOps,
+    MismatchedDomain,
+)
+
+__all__ = [
+    # core
+    "UNSETVALUE",
+    "BadInput",
+    "BadType",
+    "UninitializedLayer",
+    "UnknownLayerProperty",
+    "UnknownTechniqueProperty",
+    "MissingParameters",
+    "handler",
+    "typeChecker",
+    "typeCheckerArray",
+    "categoryChecker",
+    "loadChecker",
+    "Filter",
+    "Gradient",
+    "handle_object_placement",
+    "Layer",
+    "_LayerObj",
+    "Layout",
+    "LegendItem",
+    "Metadata",
+    "MetaDiv",
+    "Link",
+    "LinkDiv",
+    "Technique",
+    "Versions",
+    # exporters
+    "ExcelTemplates",
+    "MatrixGen",
+    "SvgTemplates",
+    "ToExcel",
+    "SVGConfig",
+    "ToSvg",
+    # generators
+    "remove_revoked_depreciated",
+    "construct_relationship_mapping",
+    "get_attack_id",
+    "build_data_strings",
+    "OverviewLayerGenerator",
+    "UsageLayerGenerator",
+    # manipulators
+    "LayerOps",
+    "InvalidFormat",
+    "BadLambda",
+    "MismatchedDomain",
+]

mitreattack/navlayers/core/__init__.py

@@ -1,7 +1,20 @@
-from .exceptions import *
+from .exceptions import (
+    UNSETVALUE,
+    BadInput,
+    BadType,
+    MissingParameters,
+    UninitializedLayer,
+    UnknownLayerProperty,
+    UnknownTechniqueProperty,
+    categoryChecker,
+    handler,
+    loadChecker,
+    typeChecker,
+    typeCheckerArray,
+)
 from .filter import Filter
 from .gradient import Gradient
-from .helpers import *
+from .helpers import handle_object_placement
 from .layer import Layer
 from .layerobj import _LayerObj
 from .layout import Layout
@@ -10,3 +23,31 @@
 from .objlink import Link, LinkDiv
 from .technique import Technique
 from .versions import Versions
+
+__all__ = [
+    "UNSETVALUE",
+    "BadInput",
+    "BadType",
+    "UninitializedLayer",
+    "UnknownLayerProperty",
+    "UnknownTechniqueProperty",
+    "MissingParameters",
+    "handler",
+    "typeChecker",
+    "typeCheckerArray",
+    "categoryChecker",
+    "loadChecker",
+    "Filter",
+    "Gradient",
+    "handle_object_placement",
+    "Layer",
+    "_LayerObj",
+    "Layout",
+    "LegendItem",
+    "Metadata",
+    "MetaDiv",
+    "Link",
+    "LinkDiv",
+    "Technique",
+    "Versions",
+]

mitreattack/navlayers/core/layer.py

@@ -10,11 +10,13 @@
 class Layer:
     """A Layer object."""
 
-    def __init__(self, init_data={}, name=None, domain=None, strict=True):
+    def __init__(self, init_data=None, name=None, domain=None, strict=True):
         """Initialize - create a new Layer object.
 
         :param init_data: Optionally provide base Layer json or string data on initialization
         """
+        if init_data is None:
+            init_data = {}
         self.__layer = None
         self.strict = strict
         if isinstance(name, str) and isinstance(domain, str):
@@ -65,7 +67,7 @@ def from_file(self, filename):
         with open(filename, "r", encoding="utf-16") as fio:
             try:
                 raw = fio.read()
-            except UnicodeError or UnicodeDecodeError:
+            except (UnicodeError, UnicodeDecodeError):
                 fallback = True
         if fallback:
             with open(filename, "r") as fio:
@@ -88,7 +90,7 @@ def _build(self):
         """Load the data stored in self.data into a LayerObj (self.layer)."""
         try:
             self.__layer = _LayerObj(self.__data["name"], self.__data["domain"])
-        except BadType or BadInput as e:
+        except (BadType, BadInput) as e:
             handler(type(self).__name__, f"Layer is malformed: {e}. Unable to load.")
             self.__layer = None
             return

mitreattack/navlayers/exporters/__init__.py

@@ -3,3 +3,12 @@
 from .svg_templates import SvgTemplates
 from .to_excel import ToExcel
 from .to_svg import SVGConfig, ToSvg
+
+__all__ = [
+    "ExcelTemplates",
+    "MatrixGen",
+    "SvgTemplates",
+    "ToExcel",
+    "SVGConfig",
+    "ToSvg",
+]

mitreattack/navlayers/exporters/excel_templates.py

@@ -34,7 +34,7 @@ def __init__(self, source="local", resource=None, domain="enterprise"):
         else:
             raise BadTemplateException
 
-    def _build_raw(self, showName=True, showID=False, sort=0, scores=[], subtechs=[], exclude=[]):
+    def _build_raw(self, showName=True, showID=False, sort=0, scores=None, subtechs=None, exclude=None):
         """Build a raw, not-yet-marked-up excel document based on the specifications.
 
         :param showName: Whether or not to display names for each entry
@@ -44,6 +44,12 @@ def _build_raw(self, showName=True, showID=False, sort=0, scores=[], subtechs=[]
         :param exclude: List of of techniques to exclude from the matrix
         :return: a openpyxl workbook object containing the raw matrix
         """
+        if scores is None:
+            scores = []
+        if subtechs is None:
+            subtechs = []
+        if exclude is None:
+            exclude = []
         self.codex = self.h._adjust_ordering(self.codex, sort, scores)
         template, joins = self.h._construct_panop(self.codex, subtechs, exclude)
         self.template = template
@@ -107,7 +113,7 @@ def _build_raw(self, showName=True, showID=False, sort=0, scores=[], subtechs=[]
 
         return wb
 
-    def export(self, showName, showID, filters=None, sort=0, scores=[], subtechs=[], exclude=[]):
+    def export(self, showName, showID, filters=None, sort=0, scores=None, subtechs=None, exclude=None):
         """Export a raw customized excel template.
 
         :param showName: Whether or not to display names for each entry
@@ -119,6 +125,12 @@ def export(self, showName, showID, filters=None, sort=0, scores=[], subtechs=[],
         :param exclude: List of of techniques to exclude from the matrix
         return: a openpyxl workbook object containing the raw matrix
         """
+        if scores is None:
+            scores = []
+        if subtechs is None:
+            subtechs = []
+        if exclude is None:
+            exclude = []
         self.codex = self.h.get_matrix(self.mode, filters=filters)
         return self._build_raw(showName, showID, sort, scores, subtechs, exclude)