SEED Package

Subpackages

• Features Package
  • Submodules
  • Steps
  • Module contents
• Management Package
  • Subpackages
    • Management Packages
      • Submodules
      • S3
      • Module contents
  • Module contents
• Mapping Package
  • Submodules
  • seed.mappings.mapper module
  • seed.mappings.reconcile_mappings module
  • seed.mappings.seed_mappings module
  • Module contents
• Templatetags Package
  • Submodules
  • Breadcrumbs
• Test Helpers Package
  • Subpackages
    • Test Helper Factor Package
      • Subpackages
        • Test Helper Factory Lib Package
          • Submodules
          • Chomsky
      • Submodules
      • Helpers
  • Module contents
• Tests Package
  • Submodules
    • Tests (Functional) Package
      • Submodules
      • Test API
      • Test Firefox
    • Test Helpers Package
      • Subpackages
        • Test Helper Factor Package
          • Subpackages
            • Test Helper Factory Lib Package
              • Submodules
              • Chomsky
          • Submodules
          • Helpers
      • Module contents
  • Admin Views
  • Decorators
  • Exporters
  • Models
  • Tasks
  • Views
  • Tests
  • Utils

Inheritance

Submodules

Decorators

seed.decorators.DecoratorMixin(decorator)

Converts a decorator written for a function view into a mixin for a class-based view.

Example:

LoginRequiredMixin = DecoratorMixin(login_required)
class MyView(LoginRequiredMixin):
    pass

class SomeView(DecoratorMixin(some_decorator), DecoratorMixin(something_else)):
    pass

seed.decorators.ajax_request(func)

• Copied from django-annoying, with a small modification. Now we also check for ‘status’ or ‘success’ keys and return correct status codes

If view returned serializable dict, returns response in a format requested by HTTP_ACCEPT header. Defaults to JSON if none requested or match.

Currently supports JSON or YAML (if installed), but can easily be extended.

Example:

@ajax_request
def my_view(request):
    news = News.objects.all()
    news_titles = [entry.title for entry in news]
    return { 'news_titles': news_titles }

seed.decorators.get_prog_key(func_name, import_file_pk)

Return the progress key for the cache

seed.decorators.lock_and_track(fn, *args, **kwargs)

Decorator to lock tasks to single executor and provide progress url.

seed.decorators.require_organization_id(fn)

Validate that organization_id is in the GET params and it’s an int.

Factory

class seed.factory.SEEDFactory

Bases: seed.test_helpers.factory.helpers.DjangoFunctionalFactory

model factory for SEED

classmethod building_snapshot(canonical_building=None, *args, **kwargs)

creates an BuildingSnapshot inst.

if canonical_building (CanonicalBuilding inst.) is None, then a CanonicalBuilding inst. is created and a BuildingSnapshot inst. is created and linked to the CanonicalBuilding inst.

Models

class seed.models.AttributeOption(*args, **kwargs)

Bases: django.db.models.base.Model

Holds a single conflicting value for a BuildingSnapshot attribute.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception AttributeOption.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

AttributeOption.building_variant

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

AttributeOption.get_value_source_display(*moreargs, **morekwargs)

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

class seed.models.BuildingAttributeVariant(*args, **kwargs)

Bases: django.db.models.base.Model

Place to keep the options of BuildingSnapshot attribute variants.

When we want to select which source’s values should sit in the Canonical Building’s position, we need to draw from a set of options determined during the matching phase. We should only have one ‘Variant’ container per field_name, per snapshot.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception BuildingAttributeVariant.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

BuildingAttributeVariant.building_snapshot

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

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

BuildingAttributeVariant.options

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.

class seed.models.BuildingSnapshot(*args, **kwargs)

Bases: django_extensions.db.models.TimeStampedModel

The periodical composite of a building from disparate data sources.

Represents the best data between all the data sources for a given building, potentially merged together with other BuildingSnapshot instances’ attribute values.

Two BuildingSnapshots can create a child, forming a match between buildings. Thusly, a BuildingSnapshot’s co-parent is the other parent of its child. The m2m field children with related name parents allow the traversal of the tree. A BuildingSnapshot can have one parent in the case where an edit to data was initiated by a user, and the original field is preserved (treating BuildingSnapshots as immutable objects) and a new BuildingSnapshot is created with the change.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception BuildingSnapshot.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

BuildingSnapshot.address_line_1_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.address_line_2_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.best_guess_canonical_building

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.block_number_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.building_certification_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.building_count_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.canonical_building

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.canonical_for_ds

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.canonicalbuilding_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.

BuildingSnapshot.child_tree

Recurse to give us a merge-order list of children.

BuildingSnapshot.children

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.

BuildingSnapshot.city_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.clean(*args, **kwargs)

BuildingSnapshot.co_parent

returns the first co-parent as a BuildingSnapshot inst

BuildingSnapshot.co_parents

returns co-parents for a BuildingSnapshot as a queryset

BuildingSnapshot.conditioned_floor_area_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.custom_id_1_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.district_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.duplicate

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.energy_alerts_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.energy_score_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.extra_data

A placeholder class that provides a way to set the attribute on the model.

BuildingSnapshot.extra_data_sources

A placeholder class that provides a way to set the attribute on the model.

BuildingSnapshot.generation_date_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.get_match_type_display(*moreargs, **morekwargs)

BuildingSnapshot.get_next_by_created(*moreargs, **morekwargs)

BuildingSnapshot.get_next_by_modified(*moreargs, **morekwargs)

BuildingSnapshot.get_previous_by_created(*moreargs, **morekwargs)

BuildingSnapshot.get_previous_by_modified(*moreargs, **morekwargs)

BuildingSnapshot.get_source_type_display(*moreargs, **morekwargs)

BuildingSnapshot.gross_floor_area_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.has_children

BuildingSnapshot.import_file

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.last_modified_by

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.lot_number_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.meters

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.

BuildingSnapshot.objects = <seed.managers.json.JsonManager object>

BuildingSnapshot.occupied_floor_area_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.owner_address_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.owner_city_state_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.owner_email_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.owner_postal_code_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.owner_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.owner_telephone_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.parent_tree

Recurse to give us merge-order list of parents.

BuildingSnapshot.parents

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.

BuildingSnapshot.pm_property_id_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.postal_code_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.project_building_snapshots

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.

BuildingSnapshot.project_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.

BuildingSnapshot.property_name_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.property_notes_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.recent_sale_date_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.recurse_tree(attr)

Recurse M2M relationship tree, extending list as we go.

Parameters:attr – str, name of attribute we wish to traverse. .e.g. ‘children’, or ‘parents’

BuildingSnapshot.release_date_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.save(*args, **kwargs)

BuildingSnapshot.site_eui_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.site_eui_weather_normalized_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.source_eui_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.source_eui_weather_normalized_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.space_alerts_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.state_province_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.super_organization

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.tax_lot_id_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.tip

returns the tip (leaf) of the BuildingSnapshot tree

BuildingSnapshot.to_dict(fields=None, include_related_data=True)

Returns a dict version of this building, either with all fields or masked to just those requested.

BuildingSnapshot.use_description_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.variants

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.

BuildingSnapshot.year_built_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

BuildingSnapshot.year_ending_source

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

class seed.models.CanonicalBuilding(*args, **kwargs)

Bases: django.db.models.base.Model

One Table to rule them all, One Table to find them, One Table to bring them all and in the database bind them.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception CanonicalBuilding.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

CanonicalBuilding.audit_logs

Accessor to the related objects manager on the one-to-many relation created by GenericRelation.

In the example:

class Post(Model):
    comments = GenericRelation(Comment)

post.comments is a ReverseGenericManyToOneDescriptor instance.

CanonicalBuilding.best_guess

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.

CanonicalBuilding.buildingsnapshot_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.

CanonicalBuilding.canonical_snapshot

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

CanonicalBuilding.labels

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.

CanonicalBuilding.objects = <seed.models.CanonicalManager object>

CanonicalBuilding.raw_objects = <django.db.models.manager.Manager object>

class seed.models.CanonicalManager

Bases: django.db.models.manager.Manager

Manager to add useful model filtering methods

get_queryset()

Return only active CanonicalBuilding rows.

class seed.models.Column(*args, **kwargs)

Bases: django.db.models.base.Model

The name of a column for a given organization.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Column.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Column.enum

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

Column.mapped_mappings

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.

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

Column.organization

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

Column.raw_mappings

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.

Column.unit

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

class seed.models.ColumnMapping(*args, **kwargs)

Bases: django.db.models.base.Model

Stores previous user-defined column mapping.

We’ll pull from this when pulling from varied, dynamic source data to present the user with previous choices for that same field in subsequent data loads.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception ColumnMapping.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

ColumnMapping.column_mapped

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.

ColumnMapping.column_raw

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.

ColumnMapping.get_source_type_display(*moreargs, **morekwargs)

ColumnMapping.is_concatenated()

Returns True if the ColumnMapping represents the concatenation of imported column names; else returns False.

ColumnMapping.is_direct()

Returns True if the ColumnMapping is a direct mapping from imported column name to either a BEDES column or a previously imported column. Returns False if the ColumnMapping represents a concatenation.

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

ColumnMapping.remove_duplicates(qs, m2m_type='column_raw')

Remove any other Column Mappings that use these columns.

Parameters:

• qs – queryset of Column. These are the Columns in a M2M with this instance.
• m2m_type – str, the name of the field we’re comparing against. Defaults to ‘column_raw’.

ColumnMapping.save(*args, **kwargs)

Overrides default model save to eliminate duplicate mappings.

Warning

Other column mappings which have the same raw_columns in them will be removed!

ColumnMapping.super_organization

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

ColumnMapping.user

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

class seed.models.Compliance(id, created, modified, compliance_type, start_date, end_date, deadline_date, project)

Bases: django_extensions.db.models.TimeStampedModel

AUDITING_COMPLIANCE_CHOICE = 'Auditing'

BENCHMARK_COMPLIANCE_CHOICE = 'Benchmarking'

COMPLIANCE_CHOICES = (('Benchmarking', <django.utils.functional.__proxy__ object at 0x7f0c80f57050>), ('Auditing', <django.utils.functional.__proxy__ object at 0x7f0c80f57210>), ('Retro Commissioning', <django.utils.functional.__proxy__ object at 0x7f0c80f57290>))

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Compliance.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Compliance.RETRO_COMMISSIONING_COMPLIANCE_CHOICE = 'Retro Commissioning'

Compliance.get_compliance_type_display(*moreargs, **morekwargs)

Compliance.get_next_by_created(*moreargs, **morekwargs)

Compliance.get_next_by_modified(*moreargs, **morekwargs)

Compliance.get_previous_by_created(*moreargs, **morekwargs)

Compliance.get_previous_by_modified(*moreargs, **morekwargs)

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

Compliance.project

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

Compliance.to_dict()

class seed.models.CustomBuildingHeaders(*args, **kwargs)

Bases: django.db.models.base.Model

Specify custom building header mapping for display.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception CustomBuildingHeaders.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

CustomBuildingHeaders.building_headers

A placeholder class that provides a way to set the attribute on the model.

CustomBuildingHeaders.objects = <seed.managers.json.JsonManager object>

CustomBuildingHeaders.super_organization

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

class seed.models.Enum(*args, **kwargs)

Bases: django.db.models.base.Model

Defines a set of enumerated types for a column.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Enum.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Enum.column_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.

Enum.enum_values

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.

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

class seed.models.EnumValue(*args, **kwargs)

Bases: django.db.models.base.Model

Individual Enumerated Type values.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception EnumValue.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

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

EnumValue.values

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.

class seed.models.Meter(*args, **kwargs)

Bases: django.db.models.base.Model

Meter specific attributes.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Meter.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Meter.building_snapshot

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.

Meter.get_energy_type_display(*moreargs, **morekwargs)

Meter.get_energy_units_display(*moreargs, **morekwargs)

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

Meter.timeseries_data

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.

class seed.models.NonCanonicalProjectBuildings(*args, **kwargs)

Bases: django.db.models.base.Model

Holds a reference to all project buildings that do not point at a canonical building snapshot.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception NonCanonicalProjectBuildings.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

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

NonCanonicalProjectBuildings.projectbuilding

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

class seed.models.Project(id, created, modified, name, slug, owner, last_modified_by, super_organization, description, status)

Bases: django_extensions.db.models.TimeStampedModel

ACTIVE_STATUS = 1

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

Project.INACTIVE_STATUS = 0

exception Project.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Project.STATUS_CHOICES = ((0, <django.utils.functional.__proxy__ object at 0x7f0c80b6cfd0>), (1, <django.utils.functional.__proxy__ object at 0x7f0c80b78050>))

Project.adding_buildings_status_percentage_cache_key

Project.building_snapshots

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.

Project.compliance_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.

Project.get_compliance()

Project.get_next_by_created(*moreargs, **morekwargs)

Project.get_next_by_modified(*moreargs, **morekwargs)

Project.get_previous_by_created(*moreargs, **morekwargs)

Project.get_previous_by_modified(*moreargs, **morekwargs)

Project.get_status_display(*moreargs, **morekwargs)

Project.has_compliance

Project.last_modified_by

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

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

Project.owner

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

Project.project_building_snapshots

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.

Project.removing_buildings_status_percentage_cache_key

Project.super_organization

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

Project.to_dict()

class seed.models.ProjectBuilding(id, created, modified, building_snapshot, project, compliant, approved_date, approver)

Bases: django_extensions.db.models.TimeStampedModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception ProjectBuilding.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

ProjectBuilding.approver

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

ProjectBuilding.building_snapshot

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

ProjectBuilding.get_next_by_created(*moreargs, **morekwargs)

ProjectBuilding.get_next_by_modified(*moreargs, **morekwargs)

ProjectBuilding.get_previous_by_created(*moreargs, **morekwargs)

ProjectBuilding.get_previous_by_modified(*moreargs, **morekwargs)

ProjectBuilding.noncanonicalprojectbuildings_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.

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

ProjectBuilding.project

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

ProjectBuilding.to_dict()

class seed.models.StatusLabel(id, created, modified, name, color, super_organization)

Bases: django_extensions.db.models.TimeStampedModel

BLUE_CHOICE = 'blue'

COLOR_CHOICES = (('red', <django.utils.functional.__proxy__ object at 0x7f0c80b78c50>), ('blue', <django.utils.functional.__proxy__ object at 0x7f0c80b835d0>), ('light blue', <django.utils.functional.__proxy__ object at 0x7f0c80b83850>), ('green', <django.utils.functional.__proxy__ object at 0x7f0c80b83890>), ('white', <django.utils.functional.__proxy__ object at 0x7f0c80b838d0>), ('orange', <django.utils.functional.__proxy__ object at 0x7f0c80b83910>), ('gray', <django.utils.functional.__proxy__ object at 0x7f0c80b83950>))

DEFAULT_LABELS = ['Residential', 'Non-Residential', 'Violation', 'Compliant', 'Missing Data', 'Questionable Report', 'Update Bldg Info', 'Call', 'Email', 'High EUI', 'Low EUI', 'Exempted', 'Extension', 'Change of Ownership']

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

StatusLabel.GRAY_CHOICE = 'gray'

StatusLabel.GREEN_CHOICE = 'green'

StatusLabel.LIGHT_BLUE_CHOICE = 'light blue'

exception StatusLabel.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

StatusLabel.ORANGE_CHOICE = 'orange'

StatusLabel.RED_CHOICE = 'red'

StatusLabel.WHITE_CHOICE = 'white'

StatusLabel.canonicalbuilding_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.

StatusLabel.get_color_display(*moreargs, **morekwargs)

StatusLabel.get_next_by_created(*moreargs, **morekwargs)

StatusLabel.get_next_by_modified(*moreargs, **morekwargs)

StatusLabel.get_previous_by_created(*moreargs, **morekwargs)

StatusLabel.get_previous_by_modified(*moreargs, **morekwargs)

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

StatusLabel.super_organization

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

StatusLabel.to_dict()

class seed.models.TimeSeries(*args, **kwargs)

Bases: django.db.models.base.Model

For storing energy use over time.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception TimeSeries.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

TimeSeries.meter

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

In the example:

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

child.parent is a ForwardManyToOneDescriptor instance.

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

class seed.models.Unit(*args, **kwargs)

Bases: django.db.models.base.Model

Unit of measure for a Column Value.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Unit.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Unit.column_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.

Unit.get_unit_type_display(*moreargs, **morekwargs)

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

seed.models.clean_canonicals(b1, b2, new_snapshot)

Make sure that we don’t leave dead limbs in our tree.

Parameters:

• b1 – BuildingSnapshot, parent 1
• b2 – BuildingSnapshot, parent 2
• new_snapshot – BuildingSnapshot, child.

seed.models.find_canonical_building_values(org)

Get all canonical building snapshots’ id info for an organization.

Parameters:org – Organization inst. Return type:list of tuples, field values specified in BS_VALUES_LIST for all canonical buildings related to an organization.

NB: This does not return a queryset!

seed.models.find_unmatched_buildings(import_file)

Get unmatched building snapshots’ id info from an import file.

Parameters:import_file – ImportFile inst. Return type:list of tuples, field values specified in BS_VALUES_LIST.

NB: This does not return a queryset!

seed.models.get_ancestors(building)

gets all the non-raw, non-composite ancestors of a building

Recursive function to traverse the tree upward.

Parameters:building – BuildingSnapshot inst. Returns:list of BuildingSnapshot inst., ancestors of building

source_type {
    2: ASSESSED_BS,
    3: PORTFOLIO_BS,
    4: COMPOSITE_BS,
    6: GREEN_BUTTON_BS
}

seed.models.get_column_mapping(column_raw, organization, attr_name='column_mapped')

Callable provided to MCM to return a previously mapped field.

Parameters:

• column_raw – str, the column name of the raw data.
• organization – Organization inst.
• attr_name – str, name of attribute on ColumnMapping to pull out. whether we’re looking at a mapping from the perspective of a raw_column (like we do when creating a mapping), or mapped_column, (like when we’re applying that mapping).

Returns:

list of mapped items, float representation of confidence.

seed.models.get_column_mappings(organization)

Returns dict of all the column mappings for an Organization’s given source type

Parameters:organization – inst, Organization. Returns:dict, list of dict.

Use this when actually performing mapping between data sources, but only call it after all of the mappings have been saved to the ColumnMapping table.

seed.models.get_or_create_canonical(b1, b2=None)

Gets most trusted Canonical Building.

Parameters:

• b1 – BuildingSnapshot model type.
• b2 – BuildingSnapshot model type.

Return type:

CanonicalBuilding inst. Will contain PK.

NB: preference is given to existing snapshots’ Canonical link.

seed.models.get_sourced_attributes(snapshot)

Return all the attribute names that get sourced.

seed.models.initialize_canonical_building(snapshot, user_pk)

Called to create a CanonicalBuilding from a single snapshot.

Parameters:

• snapshot – BuildingSnapshot inst.
• user_pk – The user id of the user initiating the CanonicalBuilding

seed.models.obj_to_dict(obj, include_m2m=True)

serializes obj for a JSON friendly version tries to serialize JsonField

seed.models.save_column_names(bs, mapping=None)

Save unique column names for extra_data in this organization.

Basically this is a record of all the extra_data keys we’ve ever seen for a particular organization.

Parameters:bs – BuildingSnapshot instance.

seed.models.save_snapshot_match(b1_pk, b2_pk, confidence=None, user=None, match_type=None, default_pk=None)

Saves a match between two models as a new snapshot; updates Canonical.

Parameters:

• b1_pk – int, id for building snapshot.
• b2_pk – int, id for building snapshot.
• confidence – (optional) float, likelihood that two models are linked.
• user – (optional) User inst, last_modified_by for BuildingSnapshot.

Return type:

BuildingSnapshot instance, post save.

Determines which Canonical link should be used. If canonical is specified, we’re probably changing a building’s Canonical link, so use that Canonical Building. Otherwise, use the model we match against. If none exists, create it.

Update mapped fields in the new snapshot, update canonical links.

seed.models.set_initial_sources(snapshot)

Sets the PK for the original sources to self.

seed.models.unmatch_snapshot_tree(building_pk)

May or may not obviate unmatch_snapshot. Experimental.

Parameters:building_pk – int - Primary Key for a BuildingSnapshot.

Warning

unmatch_snapshot_tree potentially modifies years of merged data. Anything descended from the building_pk will be deleted. The intent is to completely separate building_pk‘s influence on the resultant canonical_snapshot. The user is saying that these are separate entities after all, yes?

Basically, this function works by getting a merge order list of children from the perspective of building_pk and a list of parents from the perspective of leaf node in the child tree. We take the difference between these lists and call that the remaining_ancestors from which we reconstruct the merge tree for our CanonicalBuilding.

building_pk either gets a reactivated CanonicalBuilding, or a new one.

seed.models.update_building(old_snapshot, updated_values, user, *args, **kwargs)

Creates a new snapshot with updated values.

Reconcile

Search

Search methods pertaining to buildings.

seed.search.build_json_params(order_by, sort_reverse)

returns db_columns, extra_data_sort, and updated order_by

Parameters:order_by (str) – field to order_by Returns:tuple: db_columns: dict of known DB columns i.e. non-JsonField, extra_data_sort bool if order_by is in extra_data JsonField, order_by str if sort_reverse and DB column prepend a ‘-‘ for the django order_by

seed.search.build_shared_buildings_orgs(orgs)

returns a list of sibling and parent orgs

seed.search.convert_to_js_timestamp(timestamp)

converts a django/python datetime object to milliseconds since epoch duplicated code with seed utils due to circular imports

seed.search.create_building_queryset(orgs, exclude, order_by, other_orgs=None, extra_data_sort=False)

creates a queryset of buildings within orgs. If other_orgs, buildings in both orgs and other_orgs will be represented in the queryset.

Parameters:

• orgs – queryset of Organization inst.
• exclude – django query exclude dict.
• order_by – django query order_by str.
• other_orgs – list of other orgs to or the query

seed.search.filter_other_params(queryset, other_params, db_columns)

applies a dictionary filter to the query set. Does some domain specific parsing, mostly to remove extra query params and deal with ranges. Ranges should be passed in as ‘<field name>__lte’ or ‘<field name>__gte’ e.g. other_params = {‘gross_floor_area__lte’: 50000}

Parameters:

• Queryset queryset (Django) – queryset to be filtered
• other_params (dict) – dictionary to be parsed and applied to filter.
• db_columns (dict) – list of column names, extra_data blob outside these

Returns:

Django Queryset:

seed.search.generate_paginated_results(queryset, number_per_page=25, page=1, whitelist_orgs=None, below_threshold=False, matching=True)

Return a page of results as a list from the queryset for the given fields

Parameters:

• queryset – optional queryset to filter from
• number_per_page (int) – optional number of results per page
• page (int) – optional page of results to get
• whitelist_orgs – a queryset returning the organizations in which all building fields can be returned, otherwise only the parent organization’s exportable_fields should be returned. The whitelist_orgs are the orgs the request user belongs.
• below_threshold – True if less than the parent org’s query threshold is greater than the number of queryset results. If True, only return buildings within whitelist_orgs.
• matching – Toggle expanded parent and children data, including coparent and confidence

Usage:

generate_paginated_results(q, 1)

Returns:

[
    {
        'gross_floor_area': 1710,
        'site_eui': 123,
        'tax_lot_id': 'a-tax-lot-id',
        'year_built': 2001
    }
]

seed.search.get_building_fieldnames()

returns a list of field names for the BuildingSnapshot class/model that will be searched against

seed.search.get_orgs_w_public_fields()

returns a list of orgs that have publicly shared fields

seed.search.is_not_whitelist_building(parent_org, building, whitelist_orgs)

returns false if a building is part of the whitelist_orgs

Parameters:

• parent_org – the umbrella parent Organization instance.
• building – the BuildingSnapshot inst.
• whitelist_orgs – queryset of Organization instances.

Returns:

bool

seed.search.mask_results(search_results)

masks (deletes dict keys) for non-shared public fields

seed.search.orchestrate_search_filter_sort(params, user, skip_sort=False)

Given a parsed set of params, perform the search, filter, and sort for BuildingSnapshot’s

seed.search.paginate_results(request, search_results)

returns a paginated list of dict results

seed.search.parse_body(request)

parses the request body for search params, q, etc

Parameters:request – django wsgi request object Returns:dict

Example:

{
    'exclude': dict, exclude dict for django queryset
    'order_by': str, query order_by, defaults to 'tax_lot_id'
    'sort_reverse': bool, True if ASC, False if DSC
    'page': int, pagination page
    'number_per_page': int, number per pagination page
    'show_shared_buildings': bool, whether to search across all user's orgs
    'q': str, global search param
    'other_search_params': dict, filter params
    'project_id': str, project id if exists in body
}

seed.search.process_search_params(params, user, is_api_request=False)

Given a python representation of a search query, process it into the internal format that is used for searching, filtering, sorting, and pagination.

Parameters:

• params – a python object representing the search query
• user – the user this search is for
• is_api_request – bool, boolean whether this search is being done as an api request.

Returns:

dict

Example:

{
    'exclude': dict, exclude dict for django queryset
    'order_by': str, query order_by, defaults to 'tax_lot_id'
    'sort_reverse': bool, True if ASC, False if DSC
    'page': int, pagination page
    'number_per_page': int, number per pagination page
    'show_shared_buildings': bool, whether to search across all user's orgs
    'q': str, global search param
    'other_search_params': dict, filter params
    'project_id': str, project id if exists in body
}

seed.search.remove_results_below_q_threshold(search_results)

removes buildings if total count of buildings grouped by org is less than their org’s public query threshold

Parameters:search_results (list/queryset) – search results Returns:list or queryset

seed.search.search_buildings(q, fieldnames=None, queryset=None)

returns a queryset for matching buildings

Parameters:

• or unicode q (str) – search string
• fieldnames (list) – list of BuildingSnapshot model fieldnames (defaults to those generated by get_building_field_names())
• queryset – optional queryset to filter from, defaults to BuildingSnapshot.objects.none()

Returns:

queryset:queryset of matching buildings

seed.search.search_public_buildings(request, orgs)

returns a queryset or list of buildings matching the search params and count

Parameters:

• request – wsgi request (Django) for parsing params
• orgs – list of Organization instances to search within

Returns:

tuple (search_results_list, result count)

Tasks

exception seed.tasks.DuplicateDataError(id)

Bases: exceptions.RuntimeError

seed.tasks.apply_data_func(mappable_columns)

Returns a function that captures mappable_types in a closure and will add a key to extra data if not in mappable_types else

seed.tasks.apply_extra_data(model, key, value)

Function sent to MCM to apply mapped columns into extra_data.

seed.tasks.cache_first_rows(import_file, parser)

Cache headers, and rows 2-6 for validation/viewing.

Parameters:

• import_file – ImportFile inst.
• parser – unicode-csv.Reader instance.

Unfortunately, this is duplicated logic from data_importer, but since data_importer makes many faulty assumptions we need to do it differently.

seed.tasks.get_cache_increment_value(chunk)

seed.tasks.get_canonical_id_matches(org_id, pm_id, tax_id, custom_id)

Returns canonical snapshots that match at least one id.

seed.tasks.get_canonical_snapshots(org_id)

Return all of the BuildingSnapshots that are canonical for an org.

seed.tasks.handle_id_matches(unmatched_bs, import_file, user_pk)

“Deals with exact matches in the IDs of buildings.

seed.tasks.handle_results(results, b_idx, can_rev_idx, unmatched_list, user_pk)

Seek IDs and save our snapshot match.

Parameters:

• results – list of tuples. [(‘match’, 0.99999),...]
• b_idx – int, the index of the current building in the unmatched_list.
• can_rev_idx – dict, reverse index from match -> canonical PK.
• user_pk – user ID, used for AuditLog logging

Unmatched_list:

list of dicts, the result of a values_list query for unmatched BuildingSnapshots.

seed.tasks.is_same_snapshot(s1, s2)

Token Generator

token_generator.py - taken from django core master branch

needed a token check that would not expire after three days for sending a signup email

class seed.token_generators.SignupTokenGenerator

Bases: object

Strategy object used to generate and check tokens for the password reset mechanism.

check_token(user, token, token_expires=True)

Check that a password reset token is correct for a given user.

make_token(user)

Returns a token that can be used once to do a password reset for the given user.

URLs

Utils

Views

Module contents