Skip to main content

Japanese Postal Code Data

Project description

posuto

Posuto is a wrapper for the postal code data distributed by Japan Post. It makes mapping Japanese postal codes to addresses easier than working with the raw CSV.

Postbox character by Irasutoya

Features:

  • multi-line neighborhoods are joined
  • parenthetical notes are put in a separate field
  • change reasons are converted from flags to labels
  • romaji and kana records are unified for easy access
  • codes with multiple areas provide a list of alternates

To install:

pip install posuto

Example usage:

import posuto as 〒

🗼 = 〒.get('〒105-0011')

print(🗼)
# "東京都港区芝公園"
print(🗼.prefecture)
# "東京都"
print(🗼.kana)
# "トウキョウトミナトクシバコウエン"
print(🗼.romaji)
# "Tokyo To, Minato Ku, Shibakoen"
print(🗼.note)
# None

You can provide a postal code with basic formatting, and postal data will be returned as a named tuple with a few convenience functions. Read on for details of how quirks in the original data are handled.

Details

The original CSV files are managed in source control here but are not distributed as part of the pip package. Instead, the CSV is converted to JSON, which is then gzipped and included in the package distribution. That means most of the complexity in code in this package is actually in the build and not at runtime.

The postal code data has many irregularities and strange parts. This explains how they're dealt with.

As another note, in normal usage posuto doesn't require any dependencies. When actually building the postal data from the raw CSVs mojimoji is used for character conversion and iconv for encoding conversion.

Field names

The primary fields of an address and the translations preferred here for each are:

  • 都道府県: prefecture
  • 市区町村: city
  • 町域名: neighborhood
    🗼 = 〒.get('〒105-0011')
    print(🗼.prefecture, 🗼.city, 🗼.neighborhood)
    # "東京都 港区 芝公園"

Notes

The postal data often includes notes in the neighborhood field. These are always in parenthesis with one exception, "以下に掲載がない場合". All notes are put in the notes field, and no attempt is made to extract their yomigana or romaji (which are often not available anyway).

minatoku = 〒.get('1050000')
print(minatoku.note)
# "以下に掲載がない場合"

Yomigana

Yomigana are converted to full-width kana.

Romaji

Romaji in the original file are in all caps. This is converted to title case.

The supplied romaji make no effort to accommodate words of foreign origin, so "スウェーデンヒルズ" is rendered as "Suedenhiruzu" rather than "Sweden Hills". It may be possible to improve on this but it's outside the scope of this library; it's better to use a good romanization library.

Some more issues:

  • 1006890: "大手町 JAビル(地階・階層不明)" → "OTEMACHI JIEIEIBIRU(CHIKAI.KAISOFUM"
    • JA → JIEIEI
    • ・ → .
    • transliteration is randomly truncated, also not translated
  • 1000004: "次のビルを除く" → "TSUGINOBIRUONOZOKU"

In general use the romaji here with caution.

sweden = 〒.get('0613777')
print(sweden.romaji)
# "Hokkaido, Ishikari Gun Tobetsu Cho, Suedenhiruzu"

Long Neighborhood Names

The postal data README explains that when the neighborhood field is over 38 characters it will be continued onto multiple lines. This is not explicitly marked in the data, and where line breaks are inserted in long neighborhoods appears to be random (it's often neither after the 38th character nor at a reasonable word boundary). The only indicator of long lines is an unclosed parenthesis on the first line. Such long lines are always in order in the original file.

In posuto, the parenthetical information is considered a note and put in the note field.

omiya = 〒.get('6020847')
print(omiya)
# "京都府京都市上京区大宮町"
print(omiya.note)
# "今出川通河原町西入、今出川通寺町東入、今出川通寺町東入下る、河原町通今出川下る、河原町通今出川下る西入、寺町通今出川下る東入、中筋通石薬師上る"

Multiple Regions in One Code

Sometimes a postal code covers multiple regions. Often the city is the same and just the neighborhood varies, but sometimes part of the city field varies, or even the whole city field. Codes like this are indicated by the "一つの郵便番号で二以上の町域を表す場合の表示" field in the original CSV data, which is called multi here.

For now, if more than one region uses multiple codes, the main entry is for the first region listed in the main CSV, and other regions are stored as a list in the alternates property. There may be a better way to do this.

License

The original postal data is provided by JP Post with an indication they will not assert copyright. The code in this repository is released under the MIT or WTFPL license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for posuto, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size posuto-0.1.3.tar.gz (3.7 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page