Skip to content

Commit 88397ce

Browse files
mtmailmtmail
committed
rename CLI parameter "extra-params" to "optional-api-params"
1 parent 8060553 commit 88397ce

4 files changed

Lines changed: 26 additions & 27 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -117,23 +117,21 @@ Use `opencage forward` or `opencage reverse`
117117
```
118118
opencage forward --help
119119
120+
options:
120121
-h, --help show this help message and exit
121122
--api-key API_KEY Your OpenCage API key
122-
--input INPUT Input file name
123-
--output OUTPUT Output file name
123+
--input FILENAME Input file name
124+
--output FILENAME Output file name
124125
--headers If the first row should be treated as a header row
125-
--input-columns INPUT_COLUMNS
126-
Comma-separated list of integers (default '1')
127-
--add-columns ADD_COLUMNS
128-
Comma-separated list of output columns
129-
--workers WORKERS Number of parallel geocoding requests (default 1)
130-
--timeout TIMEOUT Timeout in seconds (default 10)
131-
--retries RETRIES Number of retries (default 5)
132-
--api-domain API_DOMAIN
133-
API domain (default api.opencagedata.com)
134-
--extra-params EXTRA_PARAMS
126+
--input-columns Comma-separated list of integers (default '1')
127+
--add-columns Comma-separated list of output columns (default 'lat,lng,_type,_category,country_code,country,state,county,_normalized_city,postcode,road,house_number,confidence,formatted')
128+
--workers Number of parallel geocoding requests (default 1)
129+
--timeout Timeout in seconds (default 10)
130+
--retries Number of retries (default 5)
131+
--api-domain API domain (default api.opencagedata.com)
132+
--optional-api-params
135133
Extra parameters for each request (e.g. language=fr,no_dedupe=1)
136-
--limit LIMIT Stop after this number of lines in the input
134+
--limit Stop after this number of lines in the input
137135
--dry-run Read the input file but no geocoding
138136
--no-progress Display no progress bar
139137
--quiet No progress bar and no messages

‎opencage/batch.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ def on_backoff(details):
140140
async def _geocode_one_address():
141141
async with OpenCageGeocode(self.options.api_key, domain=self.options.api_domain, sslcontext=self.sslcontext) as geocoder:
142142
geocoding_results = None
143-
params = { 'no_annotations': 1, **self.options.extra_params }
143+
params = { 'no_annotations': 1, **self.options.optional_api_params }
144144

145145
try:
146146
if self.options.command == 'reverse':

‎opencage/command_line.py‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ def parse_args(args):
3939

4040
for subparser in [subparser_forward, subparser_reverse]:
4141
subparser.add_argument("--api-key", required=True, type=api_key_type, help="Your OpenCage API key")
42-
subparser.add_argument("--input", required=True, type=argparse.FileType('r', encoding='utf-8'), help="Input file name")
43-
subparser.add_argument("--output", required=True, type=str, help="Output file name")
42+
subparser.add_argument("--input", required=True, type=argparse.FileType('r', encoding='utf-8'), help="Input file name", metavar='FILENAME')
43+
subparser.add_argument("--output", required=True, type=str, help="Output file name", metavar='FILENAME')
4444

4545
add_optional_arguments(subparser)
4646

@@ -59,14 +59,15 @@ def parse_args(args):
5959
def add_optional_arguments(parser):
6060
parser.add_argument("--headers", action="store_true", help="If the first row should be treated as a header row")
6161
default_input_cols = '1,2' if re.match(r'.*reverse', parser.prog) else '1'
62-
parser.add_argument("--input-columns", type=comma_separated_type(int), default=default_input_cols, help=f"Comma-separated list of integers (default '{default_input_cols}')")
63-
parser.add_argument("--add-columns", type=comma_separated_type(str), default="lat,lng,_type,_category,country_code,country,state,county,_normalized_city,postcode,road,house_number,confidence,formatted", help="Comma-separated list of output columns")
64-
parser.add_argument("--workers", type=ranged_type(int, 1, 20), default=1, help="Number of parallel geocoding requests (default 1)")
65-
parser.add_argument("--timeout", type=ranged_type(int, 1, 60), default=10, help="Timeout in seconds (default 10)")
66-
parser.add_argument("--retries", type=ranged_type(int, 1, 60), default=10, help="Number of retries (default 5)")
67-
parser.add_argument("--api-domain", type=str, default="api.opencagedata.com", help="API domain (default api.opencagedata.com)")
68-
parser.add_argument("--extra-params", type=comma_separated_dict_type, default="", help="Extra parameters for each request (e.g. language=fr,no_dedupe=1)")
69-
parser.add_argument("--limit", type=int, default=0, help="Stop after this number of lines in the input")
62+
parser.add_argument("--input-columns", type=comma_separated_type(int), default=default_input_cols, help=f"Comma-separated list of integers (default '{default_input_cols}')", metavar='')
63+
default_add_cols = 'lat,lng,_type,_category,country_code,country,state,county,_normalized_city,postcode,road,house_number,confidence,formatted'
64+
parser.add_argument("--add-columns", type=comma_separated_type(str), default=default_add_cols, help=f"Comma-separated list of output columns (default '{default_add_cols}')", metavar='')
65+
parser.add_argument("--workers", type=ranged_type(int, 1, 20), default=1, help="Number of parallel geocoding requests (default 1)", metavar='')
66+
parser.add_argument("--timeout", type=ranged_type(int, 1, 60), default=10, help="Timeout in seconds (default 10)", metavar='')
67+
parser.add_argument("--retries", type=ranged_type(int, 1, 60), default=10, help="Number of retries (default 5)", metavar='')
68+
parser.add_argument("--api-domain", type=str, default="api.opencagedata.com", help="API domain (default api.opencagedata.com)", metavar='')
69+
parser.add_argument("--optional-api-params", type=comma_separated_dict_type, default="", help="Extra parameters for each request (e.g. language=fr,no_dedupe=1)", metavar='')
70+
parser.add_argument("--limit", type=int, default=0, help="Stop after this number of lines in the input", metavar='')
7071
parser.add_argument("--dry-run", action="store_true", help="Read the input file but no geocoding")
7172
parser.add_argument("--no-progress", action="store_true", help="Display no progress bar")
7273
parser.add_argument("--quiet", action="store_true", help="No progress bar and no messages")

‎test/cli/test_cli_args.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ def test_full_argument_list():
9494
"--retries", "1",
9595
"--dry-run",
9696
"--api-domain", "bulk.opencagedata.com",
97-
"--extra-params", "extra=1",
97+
"--optional-api-params", "extra=1",
9898
"--no-progress",
9999
"--quiet"
100100
])
@@ -112,7 +112,7 @@ def test_full_argument_list():
112112
assert args.retries == 1
113113
assert args.dry_run is True
114114
assert args.api_domain == "bulk.opencagedata.com"
115-
assert args.extra_params == { "extra": "1" }
115+
assert args.optional_api_params == { "extra": "1" }
116116
assert args.no_progress is True
117117
assert args.quiet is True
118118

@@ -134,6 +134,6 @@ def test_defaults():
134134
assert args.retries == 10
135135
assert args.dry_run is False
136136
assert args.api_domain == "api.opencagedata.com"
137-
assert args.extra_params == {}
137+
assert args.optional_api_params == {}
138138
assert args.no_progress is False
139139
assert args.quiet is False

0 commit comments

Comments
 (0)