scanners.ScannerRule

Model Info

Key

Value

Model Name

ScannerRule

Verbose Name

scanner rule

Verbose Name Plural

scanner rules

Docstring

ScannerRule(id, created, modified, name, pretty_name, description, scanner, definition, action, is_active)

Is Abstract

False

Is Proxy

False

Is Managed

True

Ordering

[]

Permissions

[]

Default Permissions

(‘add’, ‘change’, ‘delete’, ‘view’)

Indexes

[]

Constraints

[]

Database Table

scanners_rules

Base Manager

objects

Default Manager

None

File

/data/olympia/src/olympia/scanners/models.py

Starting Line Number

205

Method Resolution Order

(<class ‘olympia.scanners.models.ScannerRule’>, <class ‘olympia.scanners.models.AbstractScannerRule’>, <class ‘olympia.amo.models.ModelBase’>, <class ‘olympia.amo.models.SaveUpdateMixin’>, <class ‘django.db.models.base.Model’>, <class ‘django.db.models.utils.AltersData’>, <class ‘object’>)

Fields

Field Name

Field Type

Database Column

Database Type

Verbose Name

action

PositiveSmallIntegerField

action

smallint UNSIGNED

action

created

DateTimeField

created

datetime(6)

created

definition

TextField

definition

longtext

definition

description

CharField

description

varchar(255)

description

id (pk)

AutoField

id

integer AUTO_INCREMENT

ID

is_active

BooleanField

is_active

bool

is active

modified

DateTimeField

modified

datetime(6)

modified

name

CharField

name

varchar(200)

name

pretty_name

CharField

pretty_name

varchar(255)

Human-readable name

results

ManyToManyRel

through scanners.ScannerMatch

scanner

PositiveSmallIntegerField

scanner

smallint UNSIGNED

scanner

scannermatch

ManyToOneRel

integer

fields_reverse_relation=[FieldReverseRelation(name=’results’, field_type=’ManyToManyRel’, field_db_type=’through scanners.ScannerMatch’, related_model=’scanners.ScannerResult’, field_name_on_related_model=’matched_rules’, field_type_on_related_model=’ManyToManyField’), FieldReverseRelation(name=’scannerrule_set’, field_type=’ManyToOneRel’, field_db_type=’integer’, related_model=’scanners.ScannerMatch’, field_name_on_related_model=’rule’, field_type_on_related_model=’ForeignKey’)]

Reverse Relations

Field Name

Field Type

Database Type

Related Model

Field Name on Related Model

Field Type on Related Model

results

ManyToManyRel

through scanners.ScannerMatch

scanners.ScannerResult

matched_rules

ManyToManyField

scannerrule_set

ManyToOneRel

integer

scanners.ScannerMatch

rule

ForeignKey

Methods

Other Methods

Method Name

Signature

clean_yara

(self)

get_action_display

(self, *, field=<django.db.models.fields.PositiveSmallIntegerField: action>)

get_admin_absolute_url

(self)

get_admin_url_path

(self)

get_next_by_created

(self, *, field=<django.db.models.fields.DateTimeField: created>, is_next=True, **kwargs)

get_next_by_modified

(self, *, field=<django.db.models.fields.DateTimeField: modified>, is_next=True, **kwargs)

get_previous_by_created

(self, *, field=<django.db.models.fields.DateTimeField: created>, is_next=False, **kwargs)

get_previous_by_modified

(self, *, field=<django.db.models.fields.DateTimeField: modified>, is_next=False, **kwargs)

get_scanner_display

(self, *, field=<django.db.models.fields.PositiveSmallIntegerField: scanner>)

get_unfiltered_manager

()

get_yara_externals

()

reload

(self)

serializable_reference

(self)

update

(self, **kw)

Private Methods

Method Name

Signature

_get_field_value_map

(self, meta, exclude=None)

Custom Managers

default

Class: ManagerBase

*Base for all managers in AMO.

Returns BaseQuerySets.

If a model has translated fields, they’ll be attached through a transform function.*

Custom Methods

transform(self, fn)

Custom QuerySet

Class: BaseQuerySet

Represent a lazy database lookup for a set of objects.

Custom Methods
no_transforms(self)
only_translations(self)

Remove all transforms except translations.

optimized_count(self)

*Slightly optimized count() for cases where there is a DISTINCT in the queryset.

When a count() call is made on a queryset that has a distinct, that causes django to run the full SELECT (including all fields, distinct, ordering etc) in a subquery and then COUNT() on the result of that subquery, which is costly/innefficient. That’s tracked in https://code.djangoproject.com/ticket/30685. We can’t easily fix the fact that there is a subquery, but we can avoid selecting all fields and ordering in that subquery needlessly.*

pop_transforms(self)
transform(self, fn)

objects

Class: ManagerBase

*Base for all managers in AMO.

Returns BaseQuerySets.

If a model has translated fields, they’ll be attached through a transform function.*

Custom Methods

transform(self, fn)

Custom QuerySet

Class: BaseQuerySet

Represent a lazy database lookup for a set of objects.

Custom Methods
no_transforms(self)
only_translations(self)

Remove all transforms except translations.

optimized_count(self)

*Slightly optimized count() for cases where there is a DISTINCT in the queryset.

When a count() call is made on a queryset that has a distinct, that causes django to run the full SELECT (including all fields, distinct, ordering etc) in a subquery and then COUNT() on the result of that subquery, which is costly/innefficient. That’s tracked in https://code.djangoproject.com/ticket/30685. We can’t easily fix the fact that there is a subquery, but we can avoid selecting all fields and ordering in that subquery needlessly.*

pop_transforms(self)
transform(self, fn)

!!! THIS DOCUMENT WAS AUTOGENERATED ON 2025-07-09 !!!