1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Files
peeringdb-peeringdb/docs/dev/modules/export_views.py.md
Matt Griswold 57a4175c00 Support 202202 (#1125)
* New Field "Health Check" #512

* Add status_dashboard to fields #512

* RS Peer Checkbox also visible on IX Site #727

* Add "Management" search field to Advanced Search of Exchanges #506

* wrap correctly on mobile #881

* missing delete button for user #653

* Removed cruft from IX view template #881

* To force or not to force www, that is a question #916

* add health check fields to entity creation forms (fac, ix, net) (#512)

* status_dashboard should accept null values #512

* Sort usergroup names in https://peeringdb.com/cp/peeringdb_server/userpermission/xxxxx numerically #656

* fix issue with deleted entities showing up in search results #1042

* 2FA Backup Tokens language doesn't seem correct #908

* linting

* poetry relock

* fix user permission save trying to create a user

* add status_dashboard to mock data

* docs

* add api doc regen to gen_docs call
fix issue with run_tests if BASE_URL env var is set

* fix generate_schema typo

* linting

Co-authored-by: David Poarch <dpoarch@20c.com>
Co-authored-by: Stefan Pratter <stefan@20c.com>
2022-03-08 07:27:45 -06:00

3.3 KiB

Generated from export_views.py on 2022-03-07 17:01:26.860132

peeringdb_server.export_views

Define export views used for IX-F export and advanced search file download.

Classes


AdvancedSearchExportView

AdvancedSearchExportView(peeringdb_server.export_views.ExportView)

Allow exporting of advanced search result data.

Methods

fetch

def fetch(self, request)

Fetch data from API according to GET parameters.

Note that limit and depth will be overwritten, other API parameters will be passed along as-is.

Returns: - dict: un-rendered dataset returned by API


generate

def generate(self, request)

Generate data for the reftag specified in self.tag

This function will call generate_ and return the result.

Arguments: - request

Returns: - list: list containing rendered data rows ready for export


generate_fac

def generate_fac(self, request)

Fetch facility data from the API according to request and then render it ready for export.

Arguments: - request

Returns: - list: list containing rendered data ready for export


generate_ix

def generate_ix(self, request)

Fetch exchange data from the API according to request and then render it ready for export.

Arguments: - request

Returns: - list: list containing rendered data ready for export


generate_net

def generate_net(self, request)

Fetch network data from the API according to request and then render it ready for export.

Arguments: - request

Returns: - list: list containing rendered data ready for export


generate_org

def generate_org(self, request)

Fetch organization data from the API according to request and then render it ready for export.

Arguments: - request

Returns: - list: list containing rendered data ready for export


get

def get(self, request, tag, fmt)

Handle export.

LGTM Notes: signature-mismatch: order of arguments are defined by the url routing set up for this view. (e.g., //)

The get method will never be called in a different context where a mismatching signature would matter so the lgtm warning can be ignored in this case.


ExportView

ExportView(django.views.generic.base.View)

Base class for more complex data exports.

Methods

generate

def generate(self, request)

Function that generates export data from request.

Override this.


response_csv

def response_csv(self, data)

Return Response object for CSV response.

Arguments: - data

Returns: - HttpResponse


response_json

def response_json(self, data)

Return Response object for normal json response.

Arguments: - data <list|dict>: serializable data, if list is passed you will need to specify a value in self.json_root_key

Returns: - JsonResponse


response_json_pretty

def response_json_pretty(self, data)

Return Response object for pretty (indented) json response.

Arguments: - data <list|dict>: serializable data, if list is passed tou will need to specify a value in self.json_root_key

Returns: - HttpResponse: http response with appropriate json headers, cannot use JsonResponse here because we need to specify indent level