m3-kladr - Интеграция с классификатором адресов РФ (КЛАДР)¶

Пакет m3-kladr предназначен для интеграции программных продуктов на базе платформы М3 с Классификатором адресов Российской Федерации (КЛАДР)

Содержание:

Установка¶

Пакет m3-kladr подключается как приложение M3.

Для функционирования, также требуется установка дополнительных библиотек.

Необходимые библиотеки¶

dbfpy==2.2.5
m3-core>=2.0
m3-ext3>=2.0

Установка с помощью pip¶

Установите пакет m3-kladr из репозитория пакетов компании БАРС Груп

pip install m3-kladr -i https://<PyPI_сервер_БАРС_Груп>

В этом случае будут установлены все необходимые пакеты.

Теперь можно приступать к настройке M3-приложения.

Установка из архива¶

Скачайте и распакуйте архив модуля https://bitbucket.org/barsgroup/m3-kladr/downloads

Установка из Mercurial¶

Клонируйте исходный код модуля из репозитория

hg clone https://bitbucket.org/barsgroup/m3-kladr

Установка из каталога¶

Установка

python setup.py install

Настройка¶

Подключение пакета осуществляется в файле settings.py приложения. Необходимо добавить имя пакета в раздел INSTALLED_APPS.

INSTALLED_APPS = (
    kladr,
)

Также необходимо добавить таблицы в СУБД. Если в Вашем проекте используется модуль South запустите команду:

python manage.py migrate kladr

В противном случае запустите команду:

python manage.py syncdb

Заполнение базы КЛАДРа¶

Для использования КЛАДРа необходимо заполнить базу данными. Для этого необходимо:

Загрузить актуальную базу с сайта ГНИВЦ [ссылка]

Распаковать полученный архив.

Перейти в папку проекта (где расположен файл manage.py)

Запустить команду:

python manage.py fill_kladr <параметры>

Параметры команды `fill_kladr`¶

--dbf_path – путь к папке с файлами базы КЛАДР; если параметр не указан, загрузка производится из текущей папки
--noclear – перед запуском команды не очищаются существующие данные
--force – команда не будет задавать вопросов
--update – существующие записи будут обновлены

Примеры использования¶

# Загрузка в пустую базу
python manage.py fill_kladr --dbf-path /var/kladr/

# Обновление базы
python manage.py fill_kladr --dbf-path /var/kladr/ --noclear --update

Использование КЛАДР в M3-приложениях¶

В приложениях работа с КЛАДР заключается в выборе адреса. Для добавления на форму необходимо воспользоваться классом kladr.addrfield.ExtAddrComponent:

from kladr.addrfield import ExtAddrComponent
# ***********

class SomeWindow():

    def __init__(self):

        ur_address = ExtAddrComponent()

        # *********

        self.form.extend([
            # *********
            ur_address,
        ])

По умолчанию компонент выглядит следующим образом:

Настройка отображения компонента `ExtAddrComponent`¶

С помощью атрибута level устанавливается количество отображаемых полей. Перечень значений атрибута level:

ExtAddrComponent.PLACE - отображается только поле населенного пункта
ExtAddrComponent.STREET - отображаются поля населенного пункта и улицы
ExtAddrComponent.HOUSE - отображаются поля населенного пункта, улицы и номера дома
ExtAddrComponent.FLAT - отображаются поля населенного пункта, улицы, номера дома и номера квартиры (по умолчанию)

ExtAddrComponent с атрибутом level равным ExtAddrComponent.STREET

С помощью атрибута view_mode устанавливается высота компонента. Перечень значений атрибута view_mode:

ExtAddrComponent.VIEW_1 - все поля выстраиваются в одну строку + поле полного адреса
ExtAddrComponent.VIEW_2 - все поля выстраиваются в две строки + поле полного адреса (по умолчанию). Данный параметр не используется при значении атрибута level == ExtAddrComponent.PLACE
ExtAddrComponent.VIEW_3 - все поля выстраиваются в три строки + поле полного адреса. Данный параметр не используется при значенияз атрибута level == ExtAddrComponent.PLACE или ExtAddrComponent.STREET

ExtAddrComponent с атрибутом view_mode равным ExtAddrComponent.VIEW_3

Для сохранения адреса в моделях приложения необходимо определить в них поля соответствующие кодам полей компонента ExtAddrComponent.

class SomeModel():
    # ***********
    place = models.CharField(max_length=13, null=True, default ='')  # Населенный пункт
    street = models.CharField(max_length=17, null=True, default ='') # Улица
    house = models.CharField(max_length=10, null=True, default ='')  # Дом
    flat = models.CharField(max_length=5, null=True, default ='')  # Квартира
    zipcode = models.CharField(max_length=6, null=True, default ='') # Индекс
    addr =  models.CharField(max_length=200, null=True, default ='') # Адрес

При необходимости стандартные коды полей компонента и подписи полей можно переопределить, например:

fact_address = ExtAddrComponent()
fact_address.flat_field_name = 'fact_flat'
fact_address.addr_field_name = 'fact_addr'
fact_address.street_field_name = 'fact_street'
fact_address.place_field_name = 'fact_place'
fact_address.house_field_name = 'fact_house'
fact_address.zipcode_field_name = 'fact_zipcode'
fact_address.house_label = u'Дом/Корпус'