Django Address 技术文档

1. 安装指南

1.1 安装依赖

Django Address 要求以下环境：

• Python (3.5, 3.6, 3.7, 3.8)
• Django (2.2, 3.0)

推荐并只正式支持每个 Python 和 Django 版本的最新修补版本。

1.2 安装步骤

1. 使用 pip 安装 Django Address：

pip install django-address

2. 在 settings.py 文件中的 INSTALLED_APPS 列表中添加 address：

INSTALLED_APPS = [
    # ... 
    'address',
    # ... 
]

3. 可以将 Google API 密钥存储在环境变量 GOOGLE_API_KEY 中，或者在 settings.py 中指定密钥。如果设置了环境变量，它将覆盖 settings.py 中的设置。

GOOGLE_API_KEY = 'AIzaSyD--your-google-maps-key-SjQBE'

2. 项目的使用说明

Django Address 是一组用于处理邮政地址的模型和方法。

2.1 模型结构

项目包括以下四个 Django 模型：

• Country：国家名称和代码
• State：州名称和代码，以及关联的国家
• Locality：地区名称、邮政编码，以及关联的州
• Address：原始地址、街道编号、路线、地区

2.2 AddressField

为了简化地址的存储和访问，创建了一个名为 AddressField 的 ForeignKey 子类。它提供了一种设置新地址的简便方法。

ON_DELETE 行为

默认情况下，如果删除一个与另一个对象相关联的地址，Django 会使用级联删除行为。这意味着相关对象也会被删除。您还可以在定义地址字段时设置 null=True，以便将地址设置为 NULL 而不是删除相关对象。

2.3 创建和使用

创建和使用地址字段与 ForeignKey 字段类似。

from address.models import AddressField

class MyModel(models.Model):
    address1 = AddressField()
    address2 = AddressField(related_name='+', blank=True, null=True)

设置值

可以通过分配一个 Address 对象或提供地址组件的字典来设置值。

addr = Address(...)
addr.save()
obj.address = addr

或者：

obj.address = {'street_number': '1', 'route': 'Somewhere Ave', ...}

获取值

访问地址字段时，它返回一个 Address 对象。这样可以通过对象访问所有组件。

route = obj.address.route
state_name = obj.address.locality.state.name

3. 项目 API 使用文档

目前项目中未明确提供 API 使用文档，但可以通过阅读源代码和示例项目来了解如何使用模型和表单。

4. 项目安装方式

请参考本文档的“安装指南”部分。

---

请注意，本文档使用中文编写，并采用 markdown 格式输出。如需进一步了解或使用 Django Address，请参考官方文档和示例项目。