/usr/lib/python3/dist-packages/gpxpy/gpxfield.py is in python3-gpxpy 1.1.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | # -*- coding: utf-8 -*-
# Copyright 2014 Tomo Krajina
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import inspect as mod_inspect
import datetime as mod_datetime
from . import utils as mod_utils
class GPXFieldTypeConverter:
def __init__(self, from_string, to_string):
self.from_string = from_string
self.to_string = to_string
def parse_time(string):
from . import gpx as mod_gpx
if not string:
return None
if 'T' in string:
string = string.replace('T', ' ')
if 'Z' in string:
string = string.replace('Z', '')
if '.' in string:
string = string.split('.')[0]
for date_format in mod_gpx.DATE_FORMATS:
try:
return mod_datetime.datetime.strptime(string, date_format)
except ValueError:
pass
raise mod_gpx.GPXException('Invalid time: %s' % string)
# ----------------------------------------------------------------------------------------------------
# Type converters used to convert from/to the string in the XML:
# ----------------------------------------------------------------------------------------------------
class FloatConverter:
def __init__(self):
self.from_string = lambda string : None if string is None else float(string.strip())
self.to_string = lambda flt : str(flt)
class IntConverter:
def __init__(self):
self.from_string = lambda string : None if string is None else int(string.strip())
self.to_string = lambda flt : str(flt)
class TimeConverter:
def from_string(self, string):
try:
return parse_time(string)
except:
return None
def to_string(self, time):
from . import gpx as mod_gpx
return time.strftime(mod_gpx.DATE_FORMAT) if time else None
INT_TYPE = IntConverter()
FLOAT_TYPE = FloatConverter()
TIME_TYPE = TimeConverter()
# ----------------------------------------------------------------------------------------------------
# Field converters:
# ----------------------------------------------------------------------------------------------------
class AbstractGPXField:
def __init__(self, attribute_field=None, is_list=None):
self.attribute_field = attribute_field
self.is_list = is_list
self.attribute = False
def from_xml(self, parser, node, version):
raise Exception('Not implemented')
def to_xml(self, value, version):
raise Exception('Not implemented')
class GPXField(AbstractGPXField):
"""
Used for to (de)serialize fields with simple field<->xml_tag mapping.
"""
def __init__(self, name, tag=None, attribute=None, type=None, possible=None, mandatory=None):
AbstractGPXField.__init__(self)
self.name = name
if tag and attribute:
from . import gpx as mod_gpx
raise mod_gpx.GPXException('Only tag *or* attribute may be given!')
if attribute:
self.tag = None
self.attribute = name if attribute is True else attribute
elif tag:
self.tag = name if tag is True else tag
self.attribute = None
else:
self.tag = name
self.attribute = None
self.type_converter = type
self.possible = possible
self.mandatory = mandatory
def from_xml(self, parser, node, version):
if self.attribute:
result = parser.get_node_attribute(node, self.attribute)
else:
__node = parser.get_first_child(node, self.tag)
result = parser.get_node_data(__node)
if result is None:
if self.mandatory:
from . import gpx as mod_gpx
raise mod_gpx.GPXException('%s is mandatory in %s (got %s)' % (self.name, self.tag, result))
return None
if self.type_converter:
try:
result = self.type_converter.from_string(result)
except Exception as e:
from . import gpx as mod_gpx
raise mod_gpx.GPXException('Invalid value for <%s>... %s (%s)' % (self.tag, result, e))
if self.possible:
if not (result in self.possible):
from . import gpx as mod_gpx
raise mod_gpx.GPXException('Invalid value "%s", possible: %s' % (result, self.possible))
return result
def to_xml(self, value, version):
if value is None:
return ''
if self.attribute:
return '%s="%s"' % (self.attribute, mod_utils.make_str(value))
else:
if self.type_converter:
value = self.type_converter.to_string(value)
if isinstance(self.tag, list) or isinstance(self.tag, tuple):
raise Exception('Not yet implemented')
return mod_utils.to_xml(self.tag, content=value, escape=True)
class GPXComplexField(AbstractGPXField):
def __init__(self, name, classs, tag=None, is_list=None):
AbstractGPXField.__init__(self, is_list=is_list)
self.name = name
self.tag = tag or name
self.classs = classs
def from_xml(self, parser, node, version):
if self.is_list:
result = []
for child_node in parser.get_children(node):
if parser.get_node_name(child_node) == self.tag:
result.append(gpx_fields_from_xml(self.classs, parser, child_node, version))
return result
else:
field_node = parser.get_first_child(node, self.tag)
if field_node is None:
return None
return gpx_fields_from_xml(self.classs, parser, field_node, version)
def to_xml(self, value, version):
if self.is_list:
result = ''
for obj in value:
result += gpx_fields_to_xml(obj, self.tag, version)
return result
else:
return gpx_fields_to_xml(value, self.tag, version)
class GPXEmailField(AbstractGPXField):
"""
Converts GPX1.1 email tag group from/to string.
"""
def __init__(self, name, tag=None):
self.attribute = False
self.is_list = False
self.name = name
self.tag = tag or name
def from_xml(self, parser, node, version):
email_node = parser.get_first_child(node, self.tag)
if email_node is None:
return None
email_id = parser.get_node_attribute(email_node, 'id')
email_domain = parser.get_node_attribute(email_node, 'domain')
return '%s@%s' % (email_id, email_domain)
def to_xml(self, value, version):
if not value:
return ''
if '@' in value:
pos = value.find('@')
email_id = value[:pos]
email_domain = value[pos+1:]
else:
email_id = value
email_domain = 'unknown'
return '\n<%s id="%s" domain="%s" />' % (self.tag, email_id, email_domain)
class GPXExtensionsField(AbstractGPXField):
"""
GPX1.1 extensions <extensions>...</extensions> key-value type.
"""
def __init__(self, name, tag=None):
self.attribute = False
self.name = name
self.is_list = False
self.tag = tag or 'extensions'
def from_xml(self, parser, node, version):
result = {}
if node is None:
return result
extensions_node = parser.get_first_child(node, self.tag)
if extensions_node is None:
return result
children = parser.get_children(extensions_node)
if children is None:
return result
for child in children:
result[parser.get_node_name(child)] = parser.get_node_data(child)
return result
def to_xml(self, value, version):
if not value:
return ''
result = '\n<' + self.tag + '>'
for ext_key, ext_value in value.items():
result += mod_utils.to_xml(ext_key, content=ext_value)
result += '</' + self.tag + '>'
return result
# ----------------------------------------------------------------------------------------------------
# Utility methods:
# ----------------------------------------------------------------------------------------------------
def gpx_fields_to_xml(instance, tag, version, custom_attributes=None):
fields = instance.gpx_10_fields
if version == '1.1':
fields = instance.gpx_11_fields
tag_open = bool(tag)
body = ''
if tag:
body = '\n<' + tag
if custom_attributes:
for key, value in custom_attributes.items():
body += ' %s="%s"' % (key, mod_utils.make_str(value))
for gpx_field in fields:
if isinstance(gpx_field, str):
if tag_open:
body += '>'
tag_open = False
if gpx_field[0] == '/':
body += '<%s>' % gpx_field
else:
body += '\n<%s' % gpx_field
tag_open = True
else:
value = getattr(instance, gpx_field.name)
if gpx_field.attribute:
body += ' ' + gpx_field.to_xml(value, version)
elif value is not None:
if tag_open:
body += '>'
tag_open = False
xml_value = gpx_field.to_xml(value, version)
if xml_value:
body += xml_value
if tag:
if tag_open:
body += '>'
body += '</' + tag + '>'
return body
def gpx_fields_from_xml(class_or_instance, parser, node, version):
if mod_inspect.isclass(class_or_instance):
result = class_or_instance()
else:
result = class_or_instance
fields = result.gpx_10_fields
if version == '1.1':
fields = result.gpx_11_fields
node_path = [ node ]
for gpx_field in fields:
current_node = node_path[-1]
if isinstance (gpx_field, str):
if gpx_field.startswith('/'):
node_path.pop()
else:
if current_node is None:
node_path.append(None)
else:
node_path.append(parser.get_first_child(current_node, gpx_field))
else:
if current_node is not None:
value = gpx_field.from_xml(parser, current_node, version)
setattr(result, gpx_field.name, value)
elif gpx_field.attribute:
value = gpx_field.from_xml(parser, node, version)
setattr(result, gpx_field.name, value)
return result
def gpx_check_slots_and_default_values(classs):
"""
Will fill the default values for this class. Instances will inherit those
values so we don't need to fill default values for every instance.
This method will also fill the attribute gpx_field_names with a list of
gpx field names. This can be used
"""
fields = classs.gpx_10_fields + classs.gpx_11_fields
gpx_field_names = []
instance = classs()
try:
attributes = list(filter(lambda x : x[0] != '_', dir(instance)))
attributes = list(filter(lambda x : not callable(getattr(instance, x)), attributes))
attributes = list(filter(lambda x : not x.startswith('gpx_'), attributes))
except Exception as e:
raise Exception('Error reading attributes for %s: %s' % (classs.__name__, e))
attributes.sort()
slots = list(classs.__slots__)
slots.sort()
if attributes != slots:
raise Exception('Attributes for %s is\n%s but should be\n%s' % (classs.__name__, attributes, slots))
for field in fields:
if not isinstance(field, str):
if field.is_list:
value = []
else:
value = None
try:
actual_value = getattr(instance, field.name)
except:
raise Exception('%s has no attribute %s' % (classs.__name__, field.name))
if value != actual_value:
raise Exception('Invalid default value %s.%s is %s but should be %s'
% (classs.__name__, field.name, actual_value, value))
#print('%s.%s -> %s' % (classs, field.name, value))
if not field.name in gpx_field_names:
gpx_field_names.append(field.name)
gpx_field_names = tuple(gpx_field_names)
if not hasattr(classs, '__slots__') or not classs.__slots__ or classs.__slots__ != gpx_field_names:
try: slots = classs.__slots__
except Exception as e: slots = '[Unknown:%s]' % e
raise Exception('%s __slots__ invalid, found %s, but should be %s' % (classs, slots, gpx_field_names))
|