# +====================================================================== # | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ] # +---------------------------------------------------------------------- # | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有 # +---------------------------------------------------------------------- # | 开源协议: Apache-2.0 # | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。 # +---------------------------------------------------------------------- # | 官方网站: https://www.djangoadmin.cn # +---------------------------------------------------------------------- # | 研发团队: 小蚂蚁云团队 荣誉出品 # +====================================================================== # | 版权和免责声明: # | 一、知识产权声明 # | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、 # | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权, # | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。 # | 二、使用限制与禁止条款 # | 您理解并同意,禁止将本产品用于以下任何行为: # | 1. 任何违反中华人民共和国法律法规的用途; # | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为; # | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。 # | 三、责任豁免 # | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失 # | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三 # | 方提起索赔或行政机关进行调查,您应独立承担全部责任。 # | 四、违约与法律责任 # | 如发现任何违反本声明的行为,本团队有权: # | 1. 无条件配合公安机关及其他有权机关的调查取证工作; # | 2. 依法追究相关方的民事责任,并要求赔偿全部损失; # | 3. 保留进一步采取刑事控告等法律措施的权利。 # | 五、许可范围说明 # | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包 # | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通 # | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、 # | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造 # | 成的一切经济损失及商誉损害。 # | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件 # | 许可协议》附件为准。 # +====================================================================== """ 城市模型模块 ============================================================= 该模块定义了城市/行政区划相关的数据库模型。 城市数据通常包含层级关系,通过 parent_code 或 pid 关联上级城市。 """ from django.db import models from application.models import BaseModel from utils.common import get_table_name # ============================================================= # 城市模型类 # ============================================================= class City(BaseModel): """ 城市/地区模型类 用于存储行政区划数据,包括省、市、区/县、街道四级行政区划。 数据通常来源于国家统计局发布的行政区划代码。 继承自 BaseModel,自动包含: - id: 主键 - is_delete: 逻辑删除标识 - create_user: 创建人 - create_time: 创建时间 - update_user: 更新人 - update_time: 更新时间 主要业务字段: - city_code: 城市电话区号,如北京010 - area_code: 行政编码,如北京110000 - parent_code: 上级行政编码,用于构建层级关系 - name: 城市名称 - short_name: 城市简称 - level: 城市级别(1-省份, 2-城市, 3-县区, 4-街道) - pid: 上级城市ID(冗余字段,用于快速查询) """ # ---------------------------------------------------------- # 城市区号 # ---------------------------------------------------------- # 字段说明: 城市的电话区号 # 字段类型: 字符串(CharField) # 约束: 非空(null=False),最大长度6字符 # 示例: 北京为 "010",上海为 "021" # 作用: 存储城市的电话区号 city_code = models.CharField( null=False, max_length=6, verbose_name="城市区号", help_text="城市区号", db_comment='城市区号' # 数据库字段注释 ) # ---------------------------------------------------------- # 行政编码 # ---------------------------------------------------------- # 字段说明: 国家统计局发布的行政区划代码 # 字段类型: 字符串(CharField) # 约束: 非空(null=False),最大长度20字符 # 索引: 添加了数据库索引(db_index=True)以提升查询效率 # 示例: 北京为 "110000" # 作用: 存储行政区划代码,用于数据关联和唯一标识 area_code = models.CharField( null=False, max_length=20, db_index=True, verbose_name="行政编码", help_text="行政编码", db_comment='行政编码' # 数据库字段注释 ) # ---------------------------------------------------------- # 上级行政编码 # ---------------------------------------------------------- # 字段说明: 上级行政区划的编码 # 字段类型: 字符串(CharField) # 约束: 允许为空(null=True),最大长度20字符 # 索引: 添加了数据库索引(db_index=True)以支持树形结构查询 # 作用: 存储上级行政区划的编码,用于构建层级关系树 parent_code = models.CharField( null=True, max_length=20, db_index=True, verbose_name="上级行政编码", help_text="上级行政编码", db_comment='上级行政编码' # 数据库字段注释 ) # ---------------------------------------------------------- # 邮政编码 # ---------------------------------------------------------- # 字段说明: 城市的邮政编码 # 字段类型: 字符串(CharField) # 约束: 非空(null=False),最大长度6字符 # 示例: 北京为 "100000" # 作用: 存储城市的邮政编码 zip_code = models.CharField( null=False, max_length=6, verbose_name="邮政编码", help_text="邮政编码", db_comment='邮政编码' # 数据库字段注释 ) # ---------------------------------------------------------- # 城市级别 # ---------------------------------------------------------- # 字段说明: 标识城市的行政区划级别 # 字段类型: 整数(IntegerField) # 约束: 默认值为0 # 可选值: 1-省份, 2-城市, 3-县区, 4-街道 # 作用: 标识行政区划层级,便于按级别筛选和展示 level = models.IntegerField( default=0, verbose_name="城市级别:0-省份 1-城市 2-县区 3-街道 4-社区", help_text="城市级别:0-省份 1-城市 2-县区 3-街道 4-社区", db_comment='城市级别:0-省份 1-城市 2-县区 3-街道 4-社区', # 数据库字段注释 db_default=0 ) # ---------------------------------------------------------- # 上级城市ID # ---------------------------------------------------------- # 字段说明: 上级城市的ID # 字段类型: 整数(IntegerField) # 约束: 非空(null=False),默认值为0(表示顶级) # 索引: 添加了数据库索引(db_index=True)以支持快速查询 # 作用: 冗余字段,存储上级城市的ID,用于快速构建树形结构 pid = models.IntegerField( null=False, default=0, db_index=True, verbose_name="上级城市ID", help_text="上级城市ID", db_comment='上级城市ID', # 数据库字段注释 db_default=0 ) # ---------------------------------------------------------- # 城市名称 # ---------------------------------------------------------- # 字段说明: 城市的完整标准名称 # 字段类型: 字符串(CharField) # 约束: 非空(null=False),最大长度100字符 # 作用: 存储城市的完整名称,用于列表展示和搜索 name = models.CharField( null=False, max_length=100, verbose_name="城市名称", help_text="城市名称", db_comment='城市名称' # 数据库字段注释 ) # ---------------------------------------------------------- # 城市简称 # ---------------------------------------------------------- # 字段说明: 城市的简称 # 字段类型: 字符串(CharField) # 约束: 非空(null=False),最大长度100字符 # 示例: 北京简称 "京",上海简称 "沪" # 作用: 存储城市的简称,用于简洁展示 short_name = models.CharField( null=False, max_length=100, verbose_name="城市简称", help_text="城市简称", db_comment='城市简称' # 数据库字段注释 ) # ---------------------------------------------------------- # 城市全称 # ---------------------------------------------------------- # 字段说明: 城市的完整全称(包含上级行政区划) # 字段类型: 字符串(CharField) # 约束: 允许为空(null=True),最大长度100字符 # 示例: 北京市朝阳区 # 作用: 存储城市全称,用于详情展示 full_name = models.CharField( null=True, max_length=100, verbose_name="城市全称", help_text="城市全称", db_comment='城市全称' # 数据库字段注释 ) # ---------------------------------------------------------- # 城市拼音 # ---------------------------------------------------------- # 字段说明: 城市名称的拼音 # 字段类型: 字符串(CharField) # 约束: 允许为空(null=True),最大长度100字符 # 作用: 存储城市名称的拼音,用于搜索和排序 pinyin = models.CharField( null=True, max_length=100, verbose_name="城市拼音", help_text="城市拼音", db_comment='城市拼音' # 数据库字段注释 ) # ---------------------------------------------------------- # 城市经度 # ---------------------------------------------------------- # 字段说明: 城市的中心点经度坐标 # 字段类型: 字符串(CharField) # 约束: 允许为空(null=True),最大长度100字符 # 作用: 存储城市中心点经度,用于地图展示 lng = models.CharField( null=True, max_length=100, verbose_name="城市经度", help_text="城市经度", db_comment='城市经度' # 数据库字段注释 ) # ---------------------------------------------------------- # 城市纬度 # ---------------------------------------------------------- # 字段说明: 城市的中心点纬度坐标 # 字段类型: 字符串(CharField) # 约束: 允许为空(null=True),最大长度100字符 # 作用: 存储城市中心点纬度,用于地图展示 lat = models.CharField( null=True, max_length=100, verbose_name="城市纬度", help_text="城市纬度", db_comment='城市纬度' # 数据库字段注释 ) # ============================================================= # 模型元数据配置 # ============================================================= class Meta: """ 模型元数据配置类 定义模型在数据库中的表名、显示名称等。 """ # 数据表名 # 使用配置文件中的表前缀 + "city",避免与其他应用表名冲突 db_table = get_table_name('city') # 数据表注释 db_table_comment = "城市区号" # 模型在admin后台显示的友好名称(单数) verbose_name = "城市表" # 模型在admin后台显示的友好名称(复数) verbose_name_plural = verbose_name # ============================================================= # 实例方法 # ============================================================= def __str__(self): """ 模型的字符串表示方法 当需要将模型实例转换为字符串时调用,如admin后台显示、日志输出等。 Returns: str: 包含城市ID的字符串 """ return f"城市{self.id}"