fixed linters

Signed-off-by: aryan <[email protected]>

Author: aryan-bhokare

.flake8

@@ -1,5 +1,5 @@
 [flake8]
-max-line-length = 88
+max-line-length = 140
 ignore =
     W503,
     E231,

api_app/analyzers_manager/classes.py

@@ -38,20 +38,24 @@ class BaseAnalyzerMixin(Plugin, metaclass=ABCMeta):
     @classmethod
     @property
     def config_exception(cls):
+        """Returns the AnalyzerConfigurationException class."""
         return AnalyzerConfigurationException
 
     @property
     def analyzer_name(self) -> str:
+        """Returns the name of the analyzer."""
         return self._config.name
 
     @classmethod
     @property
     def report_model(cls):
+        """Returns the AnalyzerReport model."""
         return AnalyzerReport
 
     @classmethod
     @property
     def config_model(cls):
+        """Returns the AnalyzerConfig model."""
         return AnalyzerConfig
 
     def get_exceptions_to_catch(self):
@@ -98,6 +102,12 @@ def _validate_result(self, result, level=0, max_recursion=190):
         return result
 
     def after_run_success(self, content):
+        """
+        Handles actions after a successful run.
+
+        Args:
+            content (any): The content to process after a successful run.
+        """
         super().after_run_success(self._validate_result(content, max_recursion=15))
 
 
@@ -194,6 +204,11 @@ def read_file_bytes(self) -> bytes:
 
     @property
     def filepath(self) -> str:
+        """Returns the file path, retrieving the file from storage if necessary.
+
+        Returns:
+            str: The file path.
+        """
         if not self.__filepath:
             self.__filepath = self._job.file.storage.retrieve(
                 file=self._job.file, analyzer=self.analyzer_name

api_app/decorators.py

@@ -54,6 +54,7 @@ def prevent_signal_recursion(func):
     Returns:
         function: The wrapper function that prevents recursion.
     """
+
     @functools.wraps(func)
     def no_recursion(sender, instance=None, **kwargs):
         if not instance:

api_app/filters.py

@@ -30,6 +30,7 @@ class JobFilter(filters.FilterSet):
         type (CharFilter): Custom filter method to filter by type (observable classification or file MIME type).
         name (CharFilter): Custom filter method to filter by name (observable or file name).
     """
+
     is_sample = filters.BooleanFilter()
     md5 = filters.CharFilter(lookup_expr="icontains")
     observable_name = filters.CharFilter(lookup_expr="icontains")

api_app/forms.py

@@ -12,7 +12,7 @@
 class MultilineJSONField(forms.JSONField):
     """
     A custom JSONField that handles multiline JSON input.
-    
+
     This field processes multiline input by replacing newline characters
     with the escape sequence '\\n', and also removes carriage returns and
     double quotes.
@@ -23,11 +23,12 @@ class MultilineJSONField(forms.JSONField):
         has_changed(initial, data): Checks if the field's data has changed from its initial value.
         bound_data(data, initial): Returns the data bound to the form field.
     """
+
     @staticmethod
     def _cleaning_and_multiline(value):
         """
         Process multiline input to escape newline characters and remove carriage returns and quotes.
-        
+
         Args:
             value (str): The input value to process.
 
@@ -90,6 +91,7 @@ class ParameterInlineForm(forms.ModelForm):
     Attributes:
         default (MultilineJSONField): The default value for the parameter, processed for multiline JSON input.
     """
+
     default = MultilineJSONField(required=False)
 
     class Meta:
@@ -116,6 +118,7 @@ class OrganizationPluginConfigurationForm(forms.ModelForm):
         playbook (ModelChoiceField): Field for selecting a PlaybookConfig.
         _plugins (list): List of plugin fields.
     """
+
     analyzer = forms.ModelChoiceField(
         queryset=AnalyzerConfig.objects.filter(orgs_configuration__isnull=True),
         required=False,

api_app/ingestors_manager/classes.py

@@ -17,6 +17,11 @@
 
 
 class Ingestor(Plugin, metaclass=abc.ABCMeta):
+    """
+    Abstract Base class for Ingestors.
+    Ingestors are responsible for ingesting data and generating reports.
+    """
+
     def __init__(self, config: IngestorConfig, **kwargs):
         super().__init__(config, **kwargs)
 

api_app/ingestors_manager/models.py

@@ -26,6 +26,18 @@
 
 
 class IngestorReport(AbstractReport):
+    """
+    Model representing an Ingestor Report.
+
+    Attributes:
+        config (ForeignKey): Reference to the IngestorConfig.
+        report (JSONField): JSON field storing the report data.
+        name (CharField): Name of the report.
+        task_id (UUIDField): Task ID associated with the report.
+        job (ForeignKey): Reference to the related Job.
+        max_size_report (IntegerField): Maximum size of the report.
+    """
+
     objects = IngestorReportQuerySet.as_manager()
     config = models.ForeignKey(
         "IngestorConfig", related_name="reports", on_delete=models.CASCADE
@@ -47,6 +59,9 @@ class Meta:
         indexes = AbstractReport.Meta.indexes
 
     def clean_report(self):
+        """
+        Cleans the report by trimming it to the maximum size if necessary.
+        """
         if isinstance(self.report, list) and self.max_size_report is not None:
             len_report = len(self.report)
             if len_report > self.max_size_report:
@@ -62,6 +77,20 @@ def clean(self):
 
 
 class IngestorConfig(PythonConfig, CreateJobsFromPlaybookInterface):
+    """
+    Model representing an Ingestor Configuration.
+
+    Attributes:
+        python_module (ForeignKey): Reference to the PythonModule.
+        playbooks_choice (ManyToManyField): Many-to-many relationship with PlaybookConfig.
+        user (ForeignKey): Reference to the user.
+        schedule (ForeignKey): Reference to the CrontabSchedule.
+        periodic_task (OneToOneField): One-to-one relationship with PeriodicTask.
+        maximum_jobs (IntegerField): Maximum number of jobs.
+        delay (DurationField): Delay between jobs.
+        org_configuration (None): Placeholder for organization configuration.
+    """
+
     objects = IngestorQuerySet.as_manager()
     python_module = models.ForeignKey(
         PythonModule,

api_app/interfaces.py

@@ -32,6 +32,7 @@ class CreateJobsFromPlaybookInterface:
         name (str): The name of the job.
         delay (datetime.timedelta): The delay before the job is executed.
     """
+
     playbooks_choice: QuerySet
     name: str
     delay: datetime.timedelta
@@ -228,6 +229,7 @@ class OwnershipAbstractModel(models.Model):
         for_organization (bool): Whether the model is for an organization.
         owner (ForeignKey): The owner of the model, linked to the user.
     """
+
     for_organization = models.BooleanField(default=False)
     owner = models.ForeignKey(
         settings.AUTH_USER_MODEL,

api_app/mixins.py

@@ -15,6 +15,7 @@ class PaginationMixin:
     Attributes:
         pagination_class (CustomPageNumberPagination): The pagination class to use for paginating results.
     """
+
     pagination_class = CustomPageNumberPagination
 
     def list(self, request, *args, **kwargs):

api_app/models.py

@@ -77,6 +77,7 @@ class PythonModule(models.Model):
         update_task (PeriodicTask): The task associated with updating the module.
         health_check_schedule (CrontabSchedule): The schedule for health checks.
     """
+
     module = models.CharField(max_length=120, db_index=True)
     base_path = models.CharField(
         max_length=120, db_index=True, choices=PythonModuleBasePaths.choices
@@ -243,7 +244,8 @@ class Tag(models.Model):
     Attributes:
         label (str): The label of the tag.
         color (str): The color of the tag in hex format.
-    """ 
+    """
+
     label = models.CharField(
         max_length=50,
         blank=False,
@@ -273,6 +275,7 @@ class Comment(models.Model):
         created_at (datetime): The date and time when the comment was created.
         updated_at (datetime): The date and time when the comment was last updated.
     """
+
     # make the user null if the user is deleted
     user = models.ForeignKey(
         settings.AUTH_USER_MODEL,
@@ -317,6 +320,7 @@ class Job(MP_Node):
         analyzers_report (ManyToManyField): The analyzers report for the job.
         analyzers_started (ManyToManyField): The analyzers started for the job.
     """
+
     objects = JobQuerySet.as_manager()
 
     class Meta:
@@ -774,6 +778,7 @@ class Parameter(models.Model):
         required (bool): Indicates if the parameter is mandatory.
         python_module (ForeignKey): The Python module associated with the parameter.
     """
+
     objects = ParameterQuerySet.as_manager()
 
     name = models.CharField(null=False, blank=False, max_length=50)
@@ -830,6 +835,7 @@ class PluginConfig(OwnershipAbstractModel):
         ingestor_config (ForeignKey): The ingestor configuration this config belongs to.
         pivot_config (ForeignKey): The pivot configuration this config belongs to.
     """
+
     objects = PluginConfigQuerySet.as_manager()
     value = models.JSONField(blank=True, null=True)
 
@@ -1046,6 +1052,7 @@ class OrganizationPluginConfiguration(models.Model):
         rate_limit_timeout (DurationField): The duration for which rate limits apply.
         rate_limit_enable_task (ForeignKey): The task to re-enable the configuration after a rate limit.
     """
+
     objects = OrganizationPluginConfigurationQuerySet.as_manager()
     content_type = models.ForeignKey(
         ContentType,
@@ -1074,7 +1081,7 @@ class Meta:
         unique_together = [("object_id", "organization", "content_type")]
 
     def __str__(self):
-        """Returns a string representation of the organization plugin configuration.""" 
+        """Returns a string representation of the organization plugin configuration."""
         return f"{self.config} ({self.organization})"
 
     def disable_for_rate_limit(self):
@@ -1166,6 +1173,7 @@ class ListCachable(models.Model):
         delete_class_cache_keys(user: User): Deletes cached keys for the class.
         python_path: Returns the Python path of the class.
     """
+
     class Meta:
         abstract = True
 
@@ -1204,6 +1212,7 @@ class AbstractConfig(ListCachable):
         disabled (bool): Indicates if the configuration is disabled.
         orgs_configuration (GenericRelation): The organization configurations for this config.
     """
+
     objects = AbstractConfigQuerySet.as_manager()
     name = models.CharField(
         max_length=100,
@@ -1334,6 +1343,7 @@ class AbstractReport(models.Model):
         parameters (JSONField): The parameters used for generating the report.
         sent_to_bi (bool): Indicates if the report has been sent to business intelligence (BI) systems.
     """
+
     objects = AbstractReportQuerySet.as_manager()
     # constants
     Status = ReportStatus
@@ -1421,6 +1431,7 @@ class PythonConfig(AbstractConfig):
         health_check_task (OneToOneField): The periodic task for health checks.
         health_check_status (bool): The current health check status of the plugin.
     """
+
     objects = PythonConfigQuerySet.as_manager()
     soft_time_limit = models.IntegerField(default=60, validators=[MinValueValidator(0)])
     routing_key = models.CharField(max_length=50, default="default")