onbasca.onbasca.models package

Submodules

onbasca.onbasca.models.bwfile module

class onbasca.onbasca.models.bwfile.BwFile(id, _obj_created_at, _obj_updated_at, file_created, latest_bandwidth, scanner_country, software, software_version, tor_version, consensus, destinations_countries, earliest_bandwidth, generator_started, minimum_number_eligible_relays, minimum_percent_eligible_relays, number_consensus_relays, number_eligible_relays, percent_eligible_relays, recent_consensus_count, recent_priority_list_count, recent_priority_relay_count, recent_measurement_attempt_count, recent_measurement_failure_count, recent_measurements_excluded_error_count, recent_measurements_excluded_near_count, recent_measurements_excluded_few_count, recent_measurements_excluded_old_count, time_to_report_half_network, version, _mu, _muf, _bw_sum, _bw_scaled_sum, _limit, _bw_scaled_limited_sum, _bw_scaled_limited_rounded_sum, _heartbeat)

Bases: BwFileBase

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

calculate_progress_to_report()

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

consensus

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

consensus_id

consensus_weight_percent_diff()

Return the percentage difference between the consensus weight sum and this Bandwidth file weight sum.

destinations_countries

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

earliest_bandwidth

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

eligible_relays()

estimated_time()

file_created

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

generator_started

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_consensus_weight_percent_diff_greater_maximum()

Return True and log a warning if the percentage difference between the consensus weight sum and this Bandwidth File weight sum is greater than a maximum.

Avoids sbws#40115.

is_min_percent_relays_to_report()

Return True if the minimum percentage of measured relays with respect to the consensus has been reached and False otherwise.

is_min_percent_relays_to_report_reached_before()

Return True if the minimum percentage of measured relays with respect to the consensus was reached before and False otherwise.

latest_bandwidth

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

minimum_number_eligible_relays

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

minimum_percent_eligible_relays

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

number_consensus_relays

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

number_eligible_relays

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <onbasca.onbasca.models.bwfile.BwFileManager object>

percent_eligible_relays

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

recent_consensus_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

recent_measurement_attempt_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

recent_measurement_failure_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

recent_measurements_excluded_error_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

recent_measurements_excluded_few_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

recent_measurements_excluded_near_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

recent_measurements_excluded_old_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

recent_priority_list_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

recent_priority_relay_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

relay_recent_measurement_failure_sum()

relay_recent_priority_list_sum()

relaybw_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

scanner_country

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

set_bw_scaled_limited_rounded_sum()

set_bw_scaled_limited_sum()

set_bw_scaled_sum()

set_bw_sum()

set_min_percent_relays_to_report_reached()

set_mu()

set_muf()

set_relaybws_under_min_to_report()

Modify the Bandwidth Lines adding the KeyValue under_min_report, vote.

Future version: this should probably be eliminated. It only has happened when the scanner has been running for very few days.

software

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

software_version

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

time_to_report_half_network

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

tor_version

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

version

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

write(bwfile_path=None)

class onbasca.onbasca.models.bwfile.BwFileManager(*args, **kwargs)

Bases: BwFileManagerBase

from_bandwidth_file(bandwidth_file)

generate()

https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/29710, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40006, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40023, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40049, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40017: Report relays and measurements using config.OLDEST_DATA_DAYS (28 by default) days of measurements and config.RECENT_DAYS (5 by default for the recent KeyValues).

onbasca.onbasca.models.bwfile.delete_old(sender, instance, **kwargs)

onbasca.onbasca.models.consensus module

class onbasca.onbasca.models.consensus.Consensus(_obj_created_at, _obj_updated_at, valid_after, _exits_min_bandwidth, _exits_min_position, _non_exits_min_bandwidth, _non_exits_min_position, _cc_alg_2, _bwscanner_cc_gte_1, _bridge_ratio)

Bases: ConsensusBase

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

async aget_fast_exits_min_bandwidth()

async aget_fast_stable_uptime_non_exits_fingerprints()

async asave()

async aset_exits_non_exits_bridges(testing_network=False)

async aset_fast_exits_min_bandwidth()

async aset_fast_stable_non_exits_fingerprints()

async aset_fast_stable_uptime_non_exits_fingerprints(uptime=151, min_middle_count=10, max_middle_count=30)

async aset_non_exits_fingerprints_from_file(filepath='/home/docs/.onbrisca/middles.txt')

bandwidth_sum()

Return consensus bandwidth sum.

bwfile_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

exits_with_2_in_flowctrl_fingerprints()

exits_with_bandwidth_fingerprints(routerstatus)

Return the exits with bandwidth greater than minimum.

After calculating the lowest bandwidth for exits.

exits_without_2_in_flowctrl_fingerprints()

async fast_stable_uptime_non_exits_fingerprints(uptime=151)

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

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

measurement_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

non_exits_with_bandwidth_fingerprints(routerstatus)

Return the non exits with bandwidth greater than minimum.

After calculating the lowest bandwidth for non exits.

objects = <onbasca.onbasca.models.consensus.ConsensusManager object>

relay_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

routerstatus_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

routerstatuses_ordered()

https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/34393: Measure first relays without measurements.

set_exits_fingerprints(testing_network=False)

Create a list with exits fingerprints.

To later calculate the minimum bandwidth the exits must have.

set_exits_min_bandwidth()

Calculate and set the minimum bandwidth for exits.

Ordering the exits by bandwidth, obtain the lowest bandwidth after ignoring the first 25% percent of slower exits, using the minimum position calculated by set_exits_min_position().

Avoids https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/33009 # noqa

set_exits_min_position()

Calculate 1/4 of the exits and and pick that position.

To later calculate and set in set_exits_min_bandwidth() what’s the lowest bandwidth for an exit, ignoring the 25% with lower bandwidth.

set_non_exits_fingerprints(testing_network=False)

Create a list with non exits fingerprints.

To later calculate the minimum bandwidth the non exits must have.

set_non_exits_min_bandwidth()

Calculate and set the minimum bandwidth for non exits.

Ordering the non exits by bandwidth, obtain the lowest bandwidth after ignoring the first 25% percent of slower non exits.

Avoids https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/33009 # noqa

set_non_exits_min_position()

Calculate 1/4 of the non exits and pick that position.

To later calculate and set what’s the lowest bandwidth for an non exit, ignoring the 25% with lower bandwidth.

set_params(params_dict)

valid_after

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

weight_sum()

Return consensus weight sum.

This is the same as the bandwidth sum but divided by 1000, as the consensus publish weights.

class onbasca.onbasca.models.consensus.ConsensusManager(*args, **kwargs)

Bases: ConsensusManagerBase

from_router_statuses(router_statuses, valid_after=None, testing_network=False)

set_exits_non_exits(consensus, testing_network=False)

onbasca.onbasca.models.consensus.delete_old(sender, instance, **kwargs)

onbasca.onbasca.models.heartbeat module

class onbasca.onbasca.models.heartbeat.Heartbeat(id, _obj_created_at, _obj_updated_at, loops_count, measured_count, measured_percent, previous_measured_percent, elapsed_time, _min_percent_relays_to_report_reached_at)

Bases: BaseModel

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

bwfile_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

elapsed_time

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

increment_loops()

log_status()

Print the new percentage of the different relays that were measured.

This way it can be known whether the scanner is making progress measuring all the Network.

Log the percentage, the number of relays measured and not measured, the number of loops and the time elapsed since it started measuring.

loops_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

measured_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

measured_percent

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

previous_measured_percent

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

scanner

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

onbasca.onbasca.models.heartbeat.delete_old(sender, instance, **kwargs)

onbasca.onbasca.models.measurement module

class onbasca.onbasca.models.measurement.Measurement(id, _obj_created_at, _obj_updated_at, consensus, created_at, queued_at, attempted_at, finished_at, relay, webserver, helper, as_exit, bandwidth, error)

Bases: Model

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

as_exit

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

attempted_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

bandwidth

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

consensus

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

consensus_id

created_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

error

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

finished_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

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

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

helper

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

helper_id

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <onbasca.onbasca.models.measurement.MeasurementManager object>

queued_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

relay

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

relay_id

relay_related

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

routerstatus_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

webserver

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

webserver_id

class onbasca.onbasca.models.measurement.MeasurementManager(*args, **kwargs)

Bases: Manager

mu()

muf()

onbasca.onbasca.models.relay module

class onbasca.onbasca.models.relay.Relay(*args, **kwargs)

Bases: RelayBase

Torflow::

dead = not (“Running” in ns.flags)

elif kw == “opt hibernating”:

dead = True

if not bw_observed and not dead and (“Valid” in ns.flags):

dead = True

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

property consensus_bandwidth

property consensus_bandwidth_is_unmeasured

consensuses

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property desc_bw_avg

property desc_bw_bur

property desc_bw_obs_last

property desc_bw_obs_mean

property error_circ

property error_misc

property error_second_relay

property error_stream

fingerprint

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

has_2_in_flowctrl()

helper

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

is_dead()

is_exit_can_exit_443()

property master_key_ed25519

property measured_at

measurement_latest()

measurement_latest_date()

measurements

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

measurements_count()

min_descriptor_consensus_bandwidth()

property nickname

objects = <onbasca.onbasca.models.relay.RelayManager object>

relaybw_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

relaydesc_latest_can_exit_443()

relaydesc_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

routerstatus_latest_is_exit()

routerstatus_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

set_bw_filt()

https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40059, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40080: Calculate bw stream and filtered without distinguishig relay types.

set_bw_mean()

set_bw_median()

set_bw_scaled()

https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/30274, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40088, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40075, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40014, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40091: solved by using relay descriptors’ bandwidth but no consensus weight.

set_dead()

set_measurement_latest(measurement)

set_ratio()

set_ratio_filt(muf)

set_ratio_stream(mu)

property success

class onbasca.onbasca.models.relay.RelayManager(*args, **kwargs)

Bases: RelayManagerBase

from_router_status(router_status, consensus=None)

onbasca.onbasca.models.relaybw module

class onbasca.onbasca.models.relaybw.RelayBw(id, _obj_created_at, _obj_updated_at, fingerprint, measured_at, updated_at, nickname, bw, consensus_bandwidth, consensus_bandwidth_is_unmeasured, desc_bw_avg, desc_bw_bur, desc_bw_obs_last, error_circ, error_stream, success, vote, under_min_report, bwfile, relay, bw_mean, bw_median, desc_bw_obs_mean, error_destination, error_misc, error_second_relay, master_key_ed25519, time, unmeasured, scanner, relay_in_recent_consensus_count, relay_recent_priority_list_count, relay_recent_measurement_attempt_count, relay_recent_measurement_failure_count, relay_recent_measurements_excluded_error_count, _bw_filt, _ratio_stream, _ratio_filt, _ratio, _bw_scaled, _bw_scaled_limited, _bw_scaled_limited_rounded)

Bases: RelayBwBase

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

bw

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

bw_mean

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

bw_median

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

bwfile

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

bwfile_id

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

consensus_bandwidth

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

consensus_bandwidth_is_unmeasured

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

desc_bw_avg

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

desc_bw_bur

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

desc_bw_obs_last

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

desc_bw_obs_mean

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

error_circ

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

error_destination

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

error_misc

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

error_second_relay

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

error_stream

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

fingerprint

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

master_key_ed25519

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

measured_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

nickname

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <onbasca.onbasca.models.relaybw.RelayBwManager object>

relay

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

relay_id

relay_in_recent_consensus_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

relay_recent_measurement_attempt_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

relay_recent_measurement_failure_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

relay_recent_measurements_excluded_error_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

relay_recent_priority_list_count

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

scanner

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

set_bw_scaled()

set_bw_scaled_limited()

set_bw_scaled_limited_rounded()

set_under_min_report()

Set vote and unmeasured KeyValues.

From [BandwidthFile]

generator implementations
MUST NOT change the bandwidths for under_min_report relays. Using the
same bw value makes authorities that do not understand "vote=0"
or "under_min_report=1" produce votes that don't change relay weights
too much. It also avoids flapping when the reporting threshold is
reached.

set_vote()

Set vote and unmeasured KeyValues.

From [BandwidthFile]

generator implementations
MUST set "bw=1" for unmeasured relays. Using the minimum bw value
makes authorities that do not understand "vote=0" or "unmeasured=1"
produce votes that don't change relay weights too much.

success

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

time

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

to_str()

to_str_v15()

under_min_report

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

unmeasured

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

updated_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

vote

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class onbasca.onbasca.models.relaybw.RelayBwManager(*args, **kwargs)

Bases: RelayBwManagerBase

from_relay(relay, now=None)

https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/34444, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/34309, others: relay_recent KeyValues are updated correctly since their values come from the DB and not queues of timestamps.

set_attrs(relaybw, relay)

onbasca.onbasca.models.relaydesc module

class onbasca.onbasca.models.relaydesc.RelayDesc(id, _obj_created_at, _obj_updated_at, fingerprint, published, ed25519_master_key, nickname, observed_bandwidth, average_bandwidth, burst_bandwidth, _min_bandwidth, can_exit_443, _can_exit_443_strict, _can_exit_v6_443, _uptime, relay, _hibernating, overload_general, overload_ratelimits, overload_fd_exhausted, _flowctrl_2)

Bases: RelayDescBase

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

average_bandwidth

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

burst_bandwidth

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_exit_443

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

ed25519_master_key

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

fingerprint

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

nickname

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <onbasca.onbasca.models.relaydesc.RelayDescManager object>

observed_bandwidth

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

overload_fd_exhausted

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

overload_general

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

overload_ratelimits

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

published

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

relay

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

relay_id

class onbasca.onbasca.models.relaydesc.RelayDescManager(*args, **kwargs)

Bases: RelayDescManagerBase

delete_old()

from_relay_desc(relay_desc)

onbasca.onbasca.models.routerstatus module

class onbasca.onbasca.models.routerstatus.RouterStatus(*args, **kwargs)

Bases: RouterStatusBase

Torflow:

# Routers can fall out of our consensus five different ways:
# 1. Their descriptors disappear
# 2. Their NS documents disappear
# 3. They lose the Running flag
# 4. They list a bandwidth of 0
# 5. They have 'opt hibernating' set
routers = self.c.read_routers(nslist) # Sets .down if 3,4,5

# down = dead
removed_idhexes.update(set(map(lambda r: r.idhex,
                           filter(lambda r: r.down, routers))))

for i in removed_idhexes:
  if i not in self.routers: continue
  self.routers[i].down = True
  if "Running" in self.routers[i].flags:
    self.routers[i].flags.remove("Running")
  if self.routers[i].refcount == 0:
    self.routers[i].deleted = True

  else:
    self.routers[i].deleted = True

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

address

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

bandwidth

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

consensus

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

consensus_id

fingerprint

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

has_2_in_flowctrl()

helper_candidates(relay_as_exit)

helper_path()

https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40041: do not measure non-exit as exits.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_exit

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_exit_can_exit_443()

is_unmeasured

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

nickname

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <onbasca.onbasca.models.routerstatus.RouterStatusManager object>

published

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

relay

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

relay_id

set_measurement_latest(measurement)

use_as_exit()

Return whether or not to use the relay as exit.

class onbasca.onbasca.models.routerstatus.RouterStatusManager(*args, **kwargs)

Bases: RouterStatusManagerBase

from_router_status(router_status, consensus=None)

mean_bandwidth()

onbasca.onbasca.models.scanner module

class onbasca.onbasca.models.scanner.Scanner(*args, **kwargs)

Bases: Model

Singleton class that manages the measurer threads.

And initializes all the needed objects.

https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40092, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40084, https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40087: solved by using concurrent.futures.

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

elapsed_time

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

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

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

heartbeat

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

heartbeat_id

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

init(port=None, socket=None)

classmethod load()

nickname

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

obtain_future_measurements()

queue_future_measurements()

https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40037: solved by measuring only the relays in the consensus.

run()

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

scan()

set_elapsed_time()

started_at

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

stop_threads(signal, frame, exit_code=0)

tor_version

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

uuid

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

wait_last_future_measurements()

onbasca.onbasca.models.webserver module

class onbasca.onbasca.models.webserver.WebServer(id, _obj_created_at, _obj_updated_at, url, enabled, verify)

Bases: Model

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

bridgemeasurement_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

enabled

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

measurement_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

objects = <onbasca.onbasca.models.webserver.WebServerManager object>

url

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

verify

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class onbasca.onbasca.models.webserver.WebServerManager(*args, **kwargs)

Bases: Manager

async aselect_random()

select_random()

update_from_dict(webservers_dict)

Module contents