开源项目 `chinese_province_city_area_mapper` 使用教程

项目目录结构及介绍

chinese_province_city_area_mapper/
├── chinese_province_city_area_mapper/
│   ├── __init__.py
│   ├── transformer.py
│   ├── myumap.py
│   └── data/
│       ├── province_city_area.csv
│       └── ...
├── tests/
│   ├── __init__.py
│   └── test_transformer.py
├── setup.py
├── README.md
└── requirements.txt

• chinese_province_city_area_mapper/: 项目的主目录，包含主要的Python模块和数据文件。
  • __init__.py: 初始化文件，使目录成为一个Python包。
  • transformer.py: 核心模块，包含用于转换地址字符串的类和方法。
  • myumap.py: 包含推荐的映射字典，用于处理重名区域。
  • data/: 数据文件夹，包含省、市、区三级地名的数据文件。
• tests/: 测试目录，包含项目的单元测试。
  • test_transformer.py: 针对transformer.py的单元测试。
• setup.py: 用于安装项目的脚本。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖的Python包列表。

项目的启动文件介绍

项目的启动文件是transformer.py，其中定义了主要的类CPCATransformer。这个类负责将输入的地址字符串转换为包含省、市、区信息的DataFrame。

from chinese_province_city_area_mapper.transformer import CPCATransformer

location_str = ["徐汇区虹漕路461号58号楼5楼", "泉州市洛江区万安塘西工业区"]
cpca = CPCATransformer()
df = cpca.transform(location_str)
print(df)

项目的配置文件介绍

项目没有传统的配置文件，但可以通过自定义映射字典来配置。例如，处理重名区域时，可以在创建CPCATransformer实例时传入一个自定义的映射字典。

from chinese_province_city_area_mapper.transformer import CPCATransformer

location_str = ["徐汇区虹漕路461号58号楼5楼", "泉州市洛江区万安塘西工业区", "朝阳区北苑华贸城"]
umap = {"朝阳区": "北京市"}
cpca = CPCATransformer(umap=umap)
df = cpca.transform(location_str)
print(df)

此外，项目的数据文件位于data/目录下，包含省、市、区三级地名的数据。这些数据文件是项目运行的基础，用户可以根据需要进行更新或扩展。