forked from avalentino/asfsmd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
asfsmd.py
377 lines (307 loc) · 11.5 KB
/
asfsmd.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
#!/usr/bin/env python3
# PYTHON_ARGCOMPLETE_OK
"""ASF Sentinel-1 Metadata Download tool.
Small Python tool (`asfsmd`) that allows to download XML files containing
Sentinel-1 products metadata from the ASF archive.
Sentinel-1 products are stored in the ASF arcive as ZIP files that are
quite large because they comntain both the products annotations and the
binary image data.
The `asfsmd` tool is able to retrieve only the relatively samll annotation
files (in XML format) without downloading the entire ZIP archive.
"""
import os
import sys
import json
import netrc
import fnmatch
import logging
import pathlib
import zipfile
import argparse
import warnings
import collections
from typing import Dict, List, Union
from urllib.parse import urlparse
import tqdm
import httpio
import requests
import asf_search as asf
__version__ = "1.0.0"
__all__ = ["download_annotations", "main"]
_log = logging.getLogger(__name__)
BLOACKSIZE = 1 * 1024 # 1kb
class HttpIOFile(httpio.SyncHTTPIOFile):
def open(self, session=None):
self._assert_not_closed()
if not self._closing and self._session is None:
self._session = requests.Session() if session is None else session
response = self._session.get(self.url, stream=True, **self._kwargs)
with response:
response.raise_for_status()
try:
self.length = int(response.headers["Content-Length"])
except KeyError:
raise httpio.HTTPIOError(
"Server does not report content length"
)
accept_ranges = response.headers.get("Accept-Ranges", "")
if accept_ranges.lower() != "bytes":
raise httpio.HTTPIOError(
"Server does not accept 'Range' headers"
)
return self
def query(products, auth=None):
"""Query the specified Sentinel-1 products."""
if isinstance(products, str):
products = [products]
products = [product + "-SLC" for product in products]
results = asf.product_search(products)
return results
def download_annotations_core(urls, outdir=".", auth=None,
block_size=BLOACKSIZE):
"""Download Sentinel-1 annotationd for the specified product urls."""
outdir = pathlib.Path(outdir)
patterns = [
"S1*.SAFE/manifest.safe",
"S1*.SAFE/annotation/s1*.xml",
]
with requests.Session() as session:
session.auth = auth
_log.debug("session open")
url_iter = tqdm.tqdm(urls, unit=" products")
for url in url_iter:
url_iter.set_description(url)
product_name = pathlib.Path(urlparse(url).path).stem
_log.debug(f"{product_name = }")
# if outdir.joinpath(product_name).with_suffix('.SAFE').exists():
# _log.debug(f'{product_name} already exists')
# continue
_log.debug(f"download: {product_name}")
remote_file = HttpIOFile(url, block_size=block_size)
with remote_file.open(session=session) as fd:
_log.debug(f"{url} open")
with zipfile.ZipFile(fd) as zf:
components = []
for info in zf.filelist:
for pattern in patterns:
if fnmatch.fnmatch(info.filename, pattern):
components.append(info)
break
component_iter = tqdm.tqdm(
components, unit="files", leave=False
)
for info in component_iter:
filename = pathlib.Path(info.filename)
component_iter.set_description(filename.name)
targetdir = outdir / filename.parent
outfile = targetdir / filename.name
_log.debug(f"{targetdir = }")
_log.debug(f"{outfile = }")
targetdir.mkdir(exist_ok=True, parents=True)
if outfile.exists():
_log.debug(f"{outfile = } exists")
continue
# zf.extract(info, str(targetdir))
data = zf.read(info)
outfile.write_bytes(data)
_log.debug(f"{info.filename} extracted")
def download_annotations(products, outdir=".", auth=None):
"""Download annotationd for the specified Sentinel-1 products."""
results = query(products, auth=auth)
if len(results) != len(products):
warnings.warn(
f"only {len(results)} of the {len(products)} requested products "
f"found on the remote server"
)
urls = [item.properties["url"] for item in results]
download_annotations_core(urls, outdir=outdir, auth=auth)
def _get_auth(*, user=None, pwd=None, hostname="urs.earthdata.nasa.gov"):
if user is not None and pwd is not None:
return user, pwd
elif user is None and pwd is None:
db = netrc.netrc()
user, _, pwd = db.authenticators(hostname)
return user, pwd
else:
raise ValueError(
"Both username and password must be provided to authenticate."
)
# === CLI support functions ===================================================
def _read_from_file(filename: os.PathLike) -> Union[List[str], Dict[str, str]]:
filename = pathlib.Path(filename)
if filename.suffix == '.json':
return json.loads(filename.read_text())
else:
return [line for line in filename.read_text().splitlines() if line]
# === Command Line Interface ==================================================
try:
from os import EX_OK
except ImportError:
EX_OK = 0
EX_FAILURE = 1
EX_INTERRUPT = 130
LOGFMT = "%(asctime)s %(levelname)-8s -- %(message)s"
def _autocomplete(parser):
try:
import argcomplete
except ImportError:
pass
else:
argcomplete.autocomplete(parser)
def _set_logging_control_args(parser, default_loglevel="WARNING"):
"""Set up command line options for logging control."""
loglevels = [logging.getLevelName(level) for level in range(10, 60, 10)]
parser.add_argument(
"--loglevel",
default=default_loglevel,
choices=loglevels,
help="logging level (default: %(default)s)",
)
parser.add_argument(
"-q",
"--quiet",
dest="loglevel",
action="store_const",
const="ERROR",
help="suppress standard output messages, "
"only errors are printed to screen",
)
parser.add_argument(
"-v",
"--verbose",
dest="loglevel",
action="store_const",
const="INFO",
help="print verbose output messages",
)
parser.add_argument(
"-d",
"--debug",
dest="loglevel",
action="store_const",
const="DEBUG",
help="print debug messages",
)
return parser
def _get_parser(subparsers=None):
"""Instantiate the command line argument (sub-)parser."""
name = pathlib.Path(__file__).stem
synopsis = __doc__.splitlines()[0]
doc = __doc__
if subparsers is None:
parser = argparse.ArgumentParser(prog=name, description=doc)
parser.add_argument(
"--version", action="version", version="%(prog)s v" + __version__
)
else:
parser = subparsers.add_parser(name, description=doc, help=synopsis)
# parser.set_defaults(func=info)
parser = _set_logging_control_args(parser)
# Command line options
parser.add_argument(
"-f",
"--file-list",
action="store_true",
help="read the list of products form file. "
"The file can be a JSON file (with '.json' extension) or a text file."
"The text file is expected to contain one product name per line."
"The json file can contain a list of products or a dictionary "
"containint a list of products for each key."
"In this case the key is used as sub-folder name to store the "
"corresponding products."
"Example: <OUTDIR>/<KEY>/<PRODUCT>",
)
parser.add_argument(
"-o",
"--outdir",
default=".",
help="path of the output directory (default='%(default)s')",
)
parser.add_argument(
"-u",
"--username",
help="username for ASF authentication. "
"If not provided the tool attempts to retireve the "
"authentication parameters for the user's '.netrc' file looking "
"for the host 'urs.earthdata.nasa.gov'",
)
parser.add_argument(
"-p",
"--password",
help="password for ASF authentication. "
"If not provided the tool attempts to retireve the "
"authentication parameters for the user's '.netrc' file looking "
"for the host 'urs.earthdata.nasa.gov'",
)
parser.add_argument(
"--block-size",
type=int,
default=BLOACKSIZE,
help="httpio block size in bytes (default: %(default)d)",
)
# Positional arguments
parser.add_argument(
"inputs",
nargs="+",
metavar="INPUT",
help="Sentinel-1 product name(s). "
"If the '-f' flag is set then the argument is interpreted as "
"the filename containing the list of products. "
"See '--file--list' option desctiption for more details",
)
if subparsers is None:
_autocomplete(parser)
return parser
def _parse_args(args=None, namespace=None, parser=None):
"""Parse command line arguments."""
if parser is None:
parser = _get_parser()
args = parser.parse_args(args, namespace)
# Common pre-processing of parsed arguments and consistency checks
# ...
return args
def main(*argv):
"""Implement the main CLI interface."""
# setup logging
logging.basicConfig(format=LOGFMT, level=logging.INFO) # stream=sys.stdout
logging.captureWarnings(True)
# parse cmd line arguments
args = _parse_args(argv if argv else None)
# execute main tasks
exit_code = EX_OK
try:
_log.setLevel(args.loglevel)
rootkey = ''
products_tree = collections.defaultdict(list)
if args.file_list:
for filename in args.inputs:
filename = pathlib.Path(filename)
new_product = _read_from_file(filename)
if isinstance(new_product, list):
products_tree[rootkey].extend(new_product)
else:
assert isinstance(new_product, dict)
products_tree.update(new_product)
else:
products_tree[""].extend(args.inputs)
auth = _get_auth(user=args.username, pwd=args.password)
outroot = pathlib.Path(args.outdir)
items = pbar = tqdm.tqdm(products_tree.items())
for folder, products in items:
pbar.set_description(folder if folder else 'DOWNLOAD')
outpath = outroot / folder
download_annotations(products, outdir=outpath, auth=auth)
except Exception as exc:
_log.critical(
"unexpected exception caught: {!r} {}".format(
type(exc).__name__, exc
)
)
_log.debug("stacktrace:", exc_info=True)
exit_code = EX_FAILURE
except KeyboardInterrupt:
_log.warning("Keyboard interrupt received: exit the program")
exit_code = EX_INTERRUPT
return exit_code
if __name__ == "__main__":
sys.exit(main())