mirror of
https://github.com/peeringdb/peeringdb.git
synced 2024-05-11 05:55:09 +00:00
c21130eed9
* module docstrings * db schema graph * dev docs first pass * dev docs pass 2 * add generated notification to top of generated docs files * linting * regen docs Co-authored-by: Stefan Pratter <stefan@20c.com> Co-authored-by: Sunshine Buchholz <sunshine@20c.com>
108 lines
1.5 KiB
Markdown
108 lines
1.5 KiB
Markdown
Generated from geo.py on 2021-10-15 07:56:57.376975
|
|
|
|
# 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
|
|
|
|
---
|
|
#### 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.
|
|
|
|
---
|