mirror of
https://github.com/peeringdb/peeringdb.git
synced 2024-05-11 05:55:09 +00:00
Stefan Pratter
5eb925e319
* fix next redirect when using U2F 2FA auth (#1191) * Added self identifier to API * fix migrations hierarchy after merging in previous support branch * campus object Co-authored-by: Stefan Pratter <stefan@20c.com> * fix out of bound error message add city / country to campus view * fix tests * relock poetry * linting * linting * fix docs regen * regen docs * linting * refactor self entity view to support carrier and campus object types and also make it easier to support additional object types in the future * remove debug message --------- Co-authored-by: Gajanan Patil <dipaksavaliya.python@gmail.com>
117 lines
1.7 KiB
Markdown
117 lines
1.7 KiB
Markdown
Generated from geo.py on 2023-02-14 15:33:37.135106
|
|
|
|
# peeringdb_server.geo
|
|
|
|
Utilities for geocoding and geo normalization.
|
|
|
|
# Classes
|
|
---
|
|
|
|
## Melissa
|
|
|
|
```
|
|
Melissa(builtins.object)
|
|
```
|
|
|
|
Handle requests to the melissa global address
|
|
service used for geocoding and address normalization.
|
|
|
|
|
|
### Methods
|
|
|
|
#### \__init__
|
|
`def __init__(self, key, timeout=5)`
|
|
|
|
Initialize self. See help(type(self)) for accurate signature.
|
|
|
|
---
|
|
#### global_address
|
|
`def global_address(self, **kwargs)`
|
|
|
|
Send request to the global address service.
|
|
|
|
Keyword arguments:
|
|
|
|
- address1
|
|
- address2
|
|
- city
|
|
- country
|
|
- zipcode
|
|
|
|
---
|
|
#### normalize_state
|
|
`def normalize_state(self, country_code, state)`
|
|
|
|
Takes a 2-digit country code and a state name (e.g., "Wisconsin")
|
|
and returns a normalized state name (e.g., "WI")
|
|
|
|
This will use django-cache if it exists
|
|
|
|
---
|
|
#### sanitize
|
|
`def sanitize(self, **kwargs)`
|
|
|
|
Take an international address and sanitize it
|
|
using the melissa global address service.
|
|
|
|
---
|
|
#### sanitize_address_model
|
|
`def sanitize_address_model(self, instance)`
|
|
|
|
Take an instance of AddressModel and
|
|
run its address through the normalization
|
|
process.
|
|
|
|
Note that this will not actually change fields
|
|
on the instance.
|
|
|
|
Return dict with normalized address data and
|
|
geo coordinates.
|
|
|
|
---
|
|
|
|
## NotFound
|
|
|
|
```
|
|
NotFound(builtins.OSError)
|
|
```
|
|
|
|
Base class for I/O related errors.
|
|
|
|
|
|
## RequestError
|
|
|
|
```
|
|
RequestError(builtins.OSError)
|
|
```
|
|
|
|
Base class for I/O related errors.
|
|
|
|
|
|
### Methods
|
|
|
|
#### \__init__
|
|
`def __init__(self, exc)`
|
|
|
|
Initialize self. See help(type(self)) for accurate signature.
|
|
|
|
---
|
|
|
|
## Timeout
|
|
|
|
```
|
|
Timeout(builtins.OSError)
|
|
```
|
|
|
|
Base class for I/O related errors.
|
|
|
|
|
|
### Methods
|
|
|
|
#### \__init__
|
|
`def __init__(self)`
|
|
|
|
Initialize self. See help(type(self)) for accurate signature.
|
|
|
|
---
|