Skip to content

feat: migratate docopt -> click #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
miettal wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: migratate docopt -> click #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
254 changes: 101 additions & 153 deletions jageocoder/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,174 +2,122 @@
import logging
import sys

import click
import jageocoder
from jageocoder.exceptions import JageocoderError
from docopt import docopt
from jageocoder.address import AddressLevel

HELP = """
'jageocoder' は日本の住所ジオコーダを実装した Python パッケージです。

Usage:
{p} -h
{p} -v
{p} search [-d] [--area=<area>] [--db-dir=<dir>|--url=<url>] <address>
{p} reverse [-d] [--level=<level>] [--db-dir=<dir>|--url=<url>] <longitude> <latitude>
{p} get-db-dir [-d]
{p} download-dictionary [-d] <url>
{p} install-dictionary [-d] [-y] [--db-dir=<dir>] <path>
{p} uninstall-dictionary [-d] [--db-dir=<dir>]
{p} list-datasets [-d] [--db-dir=<dir>|--url=<url>]
@click.group(context_settings=dict(help_option_names=['-h', '--help']))
@click.option('-d', '--debug', is_flag=True, help='実行時にデバッグメッセージを表示します。')
@click.version_option(jageocoder.__version__, '-v', '--version')
@click.pass_context
def cli(ctx, debug):
"""'jageocoder' は日本の住所ジオコーダを実装した Python パッケージです。"""
ctx.ensure_object(dict)
ctx.obj['debug'] = debug

Options:
-h --help このヘルプメッセージを表示します.
-v --version バージョン番号を表示します.
-d --debug 実行時にデバッグメッセージを表示します.
-y --yes 確認メッセージに対して自動的に y と答えます。
--area=<area> 検索対象地域の都道府県・市区町村名を指定します。
--level=<level> 検索する住所レベルを指定します。
--db-dir=<dir> 住所データベースのディレクトリを指定します。
--url=<url> Jageocoderサーバのエンドポイント URL を指定します。

Examples:

- 住所を検索します。

{p} search 多摩市落合1-15
{p} search --area=14152 中央1-1
{p} search --area=東京都 落合1-15
{p} search --area=町田市,八王子市 中町１－１

環境変数で検索オプションを指定できます（[]内がデフォルト）。
- JAGEOCODER_OPT_AZA_SKIP (on,off,[auto])
「字」の省略判定処理を指定します。
- JAGEOCODER_OPT_BEST_ONLY ([true],false)
最適解のみ表示するかどうかを指定します。
- JAGEOCODER_OPT_REQUIRE_COORDINATES ([true],false)
座標が登録されている住所のみ検索対象とするかどうかを指定します。
座標が登録されていない場合、経緯度 ≒ 999.9 と表示されます。
- JAGEOCODER_OPT_AUTO_REDIRECT ([true],false)
検索した住所が合併等により変わっている場合、
変更先の住所を自動的に検索するかどうかを指定します。

- 住所データベースのディレクトリを表示します。

{p} get-db-dir

- 住所データベースをインストールします。

(ウェブから最新の全国住居表示レベルデータファイルをダウンロードします)
{p} download-dictionary https://www.info-proto.com/static/jageocoder/latest/jukyo_all_v21.zip

(ダウンロードしたファイルをインストールします)
{p} install-dictionary jukyo_all_v21.zip

- 住所データベースをアンインストールします。

{p} uninstall-dictionary

- 住所データベースに含まれるデータセット一覧を表示します。

{p} list-datasets
""".format(p='jageocoder') # noqa: E501


def main():
args = docopt(HELP)

if args['--version']:
print(jageocoder.__version__)
exit(0)

if args['--debug']:
log_level = logging.DEBUG
else:
log_level = logging.INFO

if args['get-db-dir']:
print(jageocoder.get_db_dir(mode='r'))
exit(0)
log_level = logging.DEBUG if debug else logging.INFO

logger = logging.getLogger('jageocoder')
logger.setLevel(log_level)
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
console_handler.setFormatter(
logging.Formatter(
'%(levelname)s:%(name)s:%(lineno)s:%(funcName)s:%(message)s')
logging.Formatter('%(levelname)s:%(name)s:%(lineno)s:%(funcName)s:%(message)s')
)
logger.addHandler(console_handler)

if args['search']:
jageocoder.init(db_dir=args['--db-dir'], mode='r', url=args['--url'])
target_area = None
if args.get('--area'):
target_area = args['--area'].split(',')

try:
jageocoder.set_search_config(target_area=target_area)
except RuntimeError:
print((
"'{}' is incorrect as a parameter for "
"the --area option.").format(args['--area']),
file=sys.stderr)
exit(1)

try:
print(json.dumps(
jageocoder.search(query=args['<address>']),
ensure_ascii=False))
except RuntimeError as e:
print(
"An error occurred during the search: {}".format(e),
file=sys.stderr)
exit(1)

elif args['reverse']:
from jageocoder.address import AddressLevel
jageocoder.init(db_dir=args['--db-dir'], mode='r', url=args['--url'])
print(json.dumps(
jageocoder.reverse(
x=float(args['<longitude>']),
y=float(args['<latitude>']),
level=int(args['--level'] or AddressLevel.AZA)),
ensure_ascii=False))

elif args['download-dictionary']:
url = args['<url>']
try:
jageocoder.download_dictionary(url=url)
except JageocoderError:
logging.warning((
'Could not find the dictionary at the URL.'
'Make sure the URL is correct.'))
exit(1)

elif args['install-dictionary']:
path = args['<path>']
try:
jageocoder.install_dictionary(
path=path,
db_dir=args['--db-dir'],
skip_confirmation=(args['--yes'] is True),
)
except JageocoderError:
logging.warning((
"辞書データファイルが '{}' にありません。".format(path)
))
exit(1)

elif args['uninstall-dictionary']:
jageocoder.uninstall_dictionary(
db_dir=args['--db-dir'])
exit(0)

elif args['list-datasets']:
jageocoder.init(db_dir=args['--db-dir'], mode='r', url=args['--url'])
datasets = list(jageocoder.get_datasets().values())
datasets.sort(key=lambda x: x["id"])
print(json.dumps(datasets, indent=2, ensure_ascii=False))
exit(0)

@cli.command()
@click.option('--area', help='検索対象地域の都道府県・市区町村名を指定します。')
@click.option('--db-dir', help='住所データベースのディレクトリを指定します。')
@click.option('--url', help='Jageocoderサーバのエンドポイント URL を指定します。')
@click.argument('address')
@click.pass_context
def search(ctx, area, db_dir, url, address):
"""住所を検索します。"""
jageocoder.init(db_dir=db_dir, mode='r', url=url)
target_area = area.split(',') if area else None
try:
jageocoder.set_search_config(target_area=target_area)
except RuntimeError:
print(f"'{area}' is incorrect as a parameter for the --area option.", file=sys.stderr)
ctx.exit(1)
try:
result = jageocoder.search(query=address)
print(json.dumps(result, ensure_ascii=False))
except RuntimeError as e:
print(f"An error occurred during the search: {e}", file=sys.stderr)
ctx.exit(1)


@cli.command()
@click.option('--level', type=int, help='検索する住所レベルを指定します。')
@click.option('--db-dir', help='住所データベースのディレクトリを指定します。')
@click.option('--url', help='Jageocoderサーバのエンドポイント URL を指定します。')
@click.argument('longitude', type=float)
@click.argument('latitude', type=float)
def reverse(level, db_dir, url, longitude, latitude):
"""リバースジオコーディングを実行します。"""
jageocoder.init(db_dir=db_dir, mode='r', url=url)
lvl = level if level is not None else AddressLevel.AZA
result = jageocoder.reverse(x=longitude, y=latitude, level=int(lvl))
print(json.dumps(result, ensure_ascii=False))


@cli.command('get-db-dir')
def get_db_dir_cmd():
"""住所データベースのディレクトリを表示します。"""
print(jageocoder.get_db_dir(mode='r'))


@cli.command('download-dictionary')
@click.argument('url')
def download_dictionary(url):
"""住所辞書ファイルをダウンロードします。"""
try:
jageocoder.download_dictionary(url=url)
except JageocoderError:
logging.warning('Could not find the dictionary at the URL. Make sure the URL is correct.')
sys.exit(1)


@cli.command('install-dictionary')
@click.option('--db-dir', help='住所データベースのディレクトリを指定します。')
@click.option('-y', '--yes', is_flag=True, help='確認メッセージに対して自動的に y と答えます。')
@click.argument('path')
def install_dictionary(db_dir, yes, path):
"""住所辞書ファイルをインストールします。"""
try:
jageocoder.install_dictionary(path=path, db_dir=db_dir, skip_confirmation=yes)
except JageocoderError:
logging.warning("辞書データファイルが '{}' にありません。".format(path))
sys.exit(1)


@cli.command('uninstall-dictionary')
@click.option('--db-dir', help='住所データベースのディレクトリを指定します。')
def uninstall_dictionary(db_dir):
"""住所データベースをアンインストールします。"""
jageocoder.uninstall_dictionary(db_dir=db_dir)


@cli.command('list-datasets')
@click.option('--db-dir', help='住所データベースのディレクトリを指定します。')
@click.option('--url', help='Jageocoderサーバのエンドポイント URL を指定します。')
def list_datasets(db_dir, url):
"""データセットの一覧を表示します。"""
jageocoder.init(db_dir=db_dir, mode='r', url=url)
datasets = list(jageocoder.get_datasets().values())
datasets.sort(key=lambda x: x['id'])
print(json.dumps(datasets, indent=2, ensure_ascii=False))


def main():
cli(obj={})


if __name__ == '__main__':
main()

Loading